Fossology\UI\Api\Controllers\GroupController Class Reference

Controller for Group model. More...

Inheritance diagram for Fossology\UI\Api\Controllers\GroupController:

Collaboration diagram for Fossology\UI\Api\Controllers\GroupController:

Public Member Functions
	getGroups ($request, $response, $args)
	createGroup ($request, $response, $args)
	getDeletableGroups ($request, $response, $args)
	getGroupMembers ($request, $response, $args)
	addMember ($request, $response, $args)
Public Member Functions inherited from Fossology\UI\Api\Controllers\RestController
	__construct ($container)
	isJsonRequest ($request)

Additional Inherited Members
Protected Member Functions inherited from Fossology\UI\Api\Controllers\RestController
	getParsedBody (ServerRequestInterface $request)
	Parse request body as JSON and return associative PHP array. More...
	throwNotAdminException ()
	uploadAccessible ($id)
	isItemExists (int $uploadId, int $itemId)
Protected Attributes inherited from Fossology\UI\Api\Controllers\RestController
	$container
	$restHelper
	$dbHelper

Detailed Description

Controller for Group model.

Definition at line 34 of file GroupController.php.

Member Function Documentation

addMember()

Fossology\UI\Api\Controllers\GroupController::addMember	(		$request,
			$response,
			$args
	)

Add a user to a group

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns

ResponseHelper

Exceptions

HttpErrorException

Definition at line 264 of file GroupController.php.

createGroup()

Fossology\UI\Api\Controllers\GroupController::createGroup	(		$request,
			$response,
			$args
	)

Create a given group

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns

ResponseHelper

Exceptions

HttpErrorException

Definition at line 71 of file GroupController.php.

getDeletableGroups()

Fossology\UI\Api\Controllers\GroupController::getDeletableGroups	(		$request,
			$response,
			$args
	)

Get a list of groups that can be deleted

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns

ResponseHelper

Definition at line 193 of file GroupController.php.

getGroupMembers()

Fossology\UI\Api\Controllers\GroupController::getGroupMembers	(		$request,
			$response,
			$args
	)

Get users with their roles from a given group

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns

ResponseHelper

Exceptions

HttpErrorException

Definition at line 218 of file GroupController.php.

getGroups()

Fossology\UI\Api\Controllers\GroupController::getGroups	(		$request,
			$response,
			$args
	)

Get list of Groups

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns

ResponseHelper

Definition at line 45 of file GroupController.php.

---

The documentation for this class was generated from the following file:

• src/www/ui/api/Controllers/GroupController.php