Fossology\UI\Api\Controllers\CustomiseController Class Reference

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

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

Public Member Functions
	__construct ($container)
	getCustomiseData ($request, $response, $args)
	updateCustomiseData ($request, $response, $args)
	getBannerMessage ($request, $response, $args)

Private Attributes
	$sysconfigDao

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

Definition at line 26 of file CustomiseController.php.

Constructor & Destructor Documentation

__construct()

Fossology\UI\Api\Controllers\CustomiseController::__construct

(

$container

)

Constructor for base controller

Parameters

ContainerInterface

$container

Reimplemented from Fossology\UI\Api\Controllers\RestController.

Definition at line 35 of file CustomiseController.php.

Member Function Documentation

getBannerMessage()

Fossology\UI\Api\Controllers\CustomiseController::getBannerMessage	(		$request,
			$response,
			$args
	)

Get Banner Message

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns

ResponseHelper

Definition at line 91 of file CustomiseController.php.

getCustomiseData()

Fossology\UI\Api\Controllers\CustomiseController::getCustomiseData	(		$request,
			$response,
			$args
	)

Get all config data for the admin

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns

ResponseHelper

Exceptions

HttpForbiddenException

Definition at line 50 of file CustomiseController.php.

updateCustomiseData()

Fossology\UI\Api\Controllers\CustomiseController::updateCustomiseData	(		$request,
			$response,
			$args
	)

Update config data for the admin

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns

ResponseHelper

Exceptions

HttpErrorException

Definition at line 67 of file CustomiseController.php.

Member Data Documentation

$sysconfigDao

SysConfigDao Fossology\UI\Api\Controllers\CustomiseController::$sysconfigDao

private

SysConfig Dao object

Definition at line 32 of file CustomiseController.php.

---

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

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