Fossology\UI\Api\Controllers\UserController Class Reference

Controller for User model. More...

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

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

Public Member Functions
	getUsers ($request, $response, $args)
	addUser ($request, $response, $args)
	deleteUser ($request, $response, $args)
	getCurrentUser ($request, $response, $args)
	updateUser ($request, $response, $args)
	getTokens ($request, $response, $args)
Public Member Functions inherited from Fossology\UI\Api\Controllers\RestController
	__construct ($container)

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 User model.

Definition at line 36 of file UserController.php.

Member Function Documentation

addUser()

Fossology\UI\Api\Controllers\UserController::addUser	(		$request,
			$response,
			$args
	)

Create a user

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns

ResponseHelper

Exceptions

HttpInternalServerErrorException

Definition at line 77 of file UserController.php.

deleteUser()

Fossology\UI\Api\Controllers\UserController::deleteUser	(		$request,
			$response,
			$args
	)

Delete a given user

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns

ResponseHelper

Exceptions

HttpNotFoundException

Definition at line 139 of file UserController.php.

getCurrentUser()

Fossology\UI\Api\Controllers\UserController::getCurrentUser	(		$request,
			$response,
			$args
	)

Get information of current user

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns

ResponseHelper

Definition at line 159 of file UserController.php.

getTokens()

Fossology\UI\Api\Controllers\UserController::getTokens	(		$request,
			$response,
			$args
	)

Get all the REST API tokens (active | expired)

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns

ResponseHelper

Exceptions

HttpBadRequestException

Definition at line 243 of file UserController.php.

getUsers()

Fossology\UI\Api\Controllers\UserController::getUsers	(		$request,
			$response,
			$args
	)

Get list of Users

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns

ResponseHelper

Exceptions

HttpNotFoundException

Definition at line 47 of file UserController.php.

updateUser()

Fossology\UI\Api\Controllers\UserController::updateUser	(		$request,
			$response,
			$args
	)

Updates the user details

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns

ResponseHelper

Exceptions

HttpNotFoundException

Definition at line 177 of file UserController.php.

---

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

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