Controller for licenses.
More...
|
| __construct ($container) |
|
| getLicense ($request, $response, $args) |
|
| getAllLicenses ($request, $response, $args) |
|
| createLicense ($request, $response, $args) |
|
| updateLicense ($request, $response, $args) |
|
| getAllAdminAcknowledgements ($request, $response, $args) |
|
| handleAdminLicenseAcknowledgement ($request, $response, $args) |
|
| getAllLicenseStandardComments ($request, $response, $args) |
|
| handleLicenseStandardComment ($request, $response, $args) |
|
| exportAdminLicenseToCSV ($request, $response, $args) |
|
Controller for licenses.
Definition at line 41 of file LicenseController.php.
◆ __construct()
Fossology\UI\Api\Controllers\LicenseController::__construct |
( |
|
$container | ) |
|
◆ createLicense()
Fossology\UI\Api\Controllers\LicenseController::createLicense |
( |
|
$request, |
|
|
|
$response, |
|
|
|
$args |
|
) |
| |
Create a new license
- Parameters
-
Request | $request | |
ResponseHelper | $response | |
array | $args | |
- Returns
- ResponseHelper
- Exceptions
-
Definition at line 229 of file LicenseController.php.
◆ exportAdminLicenseToCSV()
Fossology\UI\Api\Controllers\LicenseController::exportAdminLicenseToCSV |
( |
|
$request, |
|
|
|
$response, |
|
|
|
$args |
|
) |
| |
Export licenses to CSV file
- Parameters
-
Request | $request | |
ResponseHelper | $response | |
array | $args | |
- Returns
- ResponseHelper
- Exceptions
-
Definition at line 844 of file LicenseController.php.
◆ getAllAdminAcknowledgements()
Fossology\UI\Api\Controllers\LicenseController::getAllAdminAcknowledgements |
( |
|
$request, |
|
|
|
$response, |
|
|
|
$args |
|
) |
| |
Get all admin license acknowledgements
- Parameters
-
Request | $request | |
ResponseHelper | $response | |
array | $args | |
- Returns
- ResponseHelper
- Exceptions
-
Definition at line 468 of file LicenseController.php.
◆ getAllLicenses()
Fossology\UI\Api\Controllers\LicenseController::getAllLicenses |
( |
|
$request, |
|
|
|
$response, |
|
|
|
$args |
|
) |
| |
Get list of all licenses, paginated upon request params
- Parameters
-
Request | $request | |
ResponseHelper | $response | |
array | $args | |
- Returns
- ResponseHelper
- Exceptions
-
Definition at line 152 of file LicenseController.php.
◆ getAllLicenseStandardComments()
Fossology\UI\Api\Controllers\LicenseController::getAllLicenseStandardComments |
( |
|
$request, |
|
|
|
$response, |
|
|
|
$args |
|
) |
| |
Get all license standard comments
- Parameters
-
Request | $request | |
ResponseHelper | $response | |
array | $args | |
- Returns
- ResponseHelper
Definition at line 576 of file LicenseController.php.
◆ getLicense()
Fossology\UI\Api\Controllers\LicenseController::getLicense |
( |
|
$request, |
|
|
|
$response, |
|
|
|
$args |
|
) |
| |
Get the license information based on the provided parameters
- Parameters
-
Request | $request | |
ResponseHelper | $response | |
array | $args | |
- Returns
- ResponseHelper
- Exceptions
-
Definition at line 98 of file LicenseController.php.
◆ handleAdminLicenseAcknowledgement()
Fossology\UI\Api\Controllers\LicenseController::handleAdminLicenseAcknowledgement |
( |
|
$request, |
|
|
|
$response, |
|
|
|
$args |
|
) |
| |
Add, Edit & toggle admin license acknowledgement.
- Parameters
-
Request | $request | |
ResponseHelper | $response | |
array | $args | |
- Returns
- ResponseHelper
- Exceptions
-
Definition at line 491 of file LicenseController.php.
◆ handleLicenseStandardComment()
Fossology\UI\Api\Controllers\LicenseController::handleLicenseStandardComment |
( |
|
$request, |
|
|
|
$response, |
|
|
|
$args |
|
) |
| |
Add, Edit & toggle license standard comment.
- Parameters
-
Request | $request | |
ResponseHelper | $response | |
array | $args | |
- Returns
- ResponseHelper
- Exceptions
-
Definition at line 596 of file LicenseController.php.
◆ isNewLicense()
Fossology\UI\Api\Controllers\LicenseController::isNewLicense |
( |
|
$shortName, |
|
|
|
$groupId = 0 |
|
) |
| |
|
private |
Check if the given shortname already exists in DB.
- Parameters
-
string | $shortName | Shortname to check |
integer | $groupId | Group ID if candidate license |
Definition at line 351 of file LicenseController.php.
◆ updateLicense()
Fossology\UI\Api\Controllers\LicenseController::updateLicense |
( |
|
$request, |
|
|
|
$response, |
|
|
|
$args |
|
) |
| |
Update a license
- Parameters
-
Request | $request | |
ResponseHelper | $response | |
array | $args | |
- Returns
- ResponseHelper
- Exceptions
-
Definition at line 290 of file LicenseController.php.
◆ $adminLicenseAckDao
◆ $licenseDao
LicenseDao Fossology\UI\Api\Controllers\LicenseController::$licenseDao |
|
private |
◆ $licenseStdCommentDao
◆ ACTIVE_PARAM
const Fossology\UI\Api\Controllers\LicenseController::ACTIVE_PARAM = "active" |
◆ LICENSE_FETCH_LIMIT
const Fossology\UI\Api\Controllers\LicenseController::LICENSE_FETCH_LIMIT = 100 |
◆ LIMIT_PARAM
const Fossology\UI\Api\Controllers\LicenseController::LIMIT_PARAM = "limit" |
◆ PAGE_PARAM
const Fossology\UI\Api\Controllers\LicenseController::PAGE_PARAM = "page" |
The documentation for this class was generated from the following file: