Fossology\UI\Api\Controllers\ObligationController Class Reference

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

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

Public Member Functions
	__construct ($container)
	obligationsList ($request, $response, $args)
	obligationsDetails ($request, $response, $args)
	obligationsAllDetails ($request, $response, $args)
	deleteObligation ($request, $response, $args)
	exportObligationsToCSV ($request, $response, $args)
	exportObligationsToJSON ($request, $response, $args)
Public Member Functions inherited from Fossology\UI\Api\Controllers\RestController
	isJsonRequest ($request)

Private Member Functions
	createExtendedObligationFromId ($obligationId)

Private Attributes
	$obligationMap

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 28 of file ObligationController.php.

Constructor & Destructor Documentation

__construct()

Fossology\UI\Api\Controllers\ObligationController::__construct

(

$container

)

Constructor for base controller

Parameters

ContainerInterface

$container

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

Definition at line 36 of file ObligationController.php.

Member Function Documentation

createExtendedObligationFromId()

Fossology\UI\Api\Controllers\ObligationController::createExtendedObligationFromId (   $obligationId )

private

Create extended Obligation Model object for a given obligation ID.

Parameters

int

$obligationId

Obligation ID to get object for

Returns

Obligation Obligation model object for given id

Definition at line 109 of file ObligationController.php.

deleteObligation()

Fossology\UI\Api\Controllers\ObligationController::deleteObligation	(		$request,
			$response,
			$args
	)

Delete obligation based on id

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns

ResponseHelper

Exceptions

HttpNotFoundException

Definition at line 131 of file ObligationController.php.

exportObligationsToCSV()

Fossology\UI\Api\Controllers\ObligationController::exportObligationsToCSV	(		$request,
			$response,
			$args
	)

Export Obligations to CSV

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns

ResponseHelper

Exceptions

HttpErrorException

Definition at line 191 of file ObligationController.php.

exportObligationsToJSON()

Fossology\UI\Api\Controllers\ObligationController::exportObligationsToJSON	(		$request,
			$response,
			$args
	)

Export Obligations to JSON

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns

ResponseHelper

Exceptions

HttpErrorException

Definition at line 257 of file ObligationController.php.

obligationsAllDetails()

Fossology\UI\Api\Controllers\ObligationController::obligationsAllDetails	(		$request,
			$response,
			$args
	)

Get details of all obligations

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns

ResponseHelper

Definition at line 91 of file ObligationController.php.

obligationsDetails()

Fossology\UI\Api\Controllers\ObligationController::obligationsDetails	(		$request,
			$response,
			$args
	)

Get details of obligations based on id

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns

ResponseHelper

Exceptions

HttpNotFoundException

Definition at line 72 of file ObligationController.php.

obligationsList()

Fossology\UI\Api\Controllers\ObligationController::obligationsList	(		$request,
			$response,
			$args
	)

Get all list of obligations

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns

ResponseHelper

Definition at line 50 of file ObligationController.php.

Member Data Documentation

$obligationMap

ObligationMap Fossology\UI\Api\Controllers\ObligationController::$obligationMap

private

Obligation Map object

Definition at line 34 of file ObligationController.php.

---

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

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