Fossology\UI\Api\Controllers\ReportController Class Reference

Controller for Maintenance model. More...

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

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

Static Public Member Functions
static	buildDownloadPath ($request, $jobId)

Private Member Functions
	getUpload ($uploadId)
	checkReport ($id)

Private Attributes
	$reportsAllowed
	$importAllowed

Additional Inherited Members
Public Member Functions inherited from Fossology\UI\Api\Controllers\RestController
	__construct ($container)
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 Maintenance model.

Controller for report path.

Valid status inputs

Definition at line 42 of file ReportController.php.

Member Function Documentation

buildDownloadPath()

static Fossology\UI\Api\Controllers\ReportController::buildDownloadPath (   $request,   $jobId  )

static

Generate the path to download URL based on current request and new Job id

Parameters

SlimRequest	$request
integer	$jobId	The new job id created by agent

Returns

string The path to download the report

Definition at line 180 of file ReportController.php.

checkReport()

Fossology\UI\Api\Controllers\ReportController::checkReport (   $id )

private

Check if a report is scheduled with the given job id

Parameters

int

$id

Job id

Returns

boolean

Exceptions

HttpErrorException

Definition at line 242 of file ReportController.php.

getUpload()

Fossology\UI\Api\Controllers\ReportController::getUpload (   $uploadId )

private

Get the upload object from a given upload id

Parameters

int

$uploadId

Upload Id to get from

Returns

Fossology::UI::Api::Models::Info|Upload|NULL

Exceptions

HttpErrorException

Definition at line 158 of file ReportController.php.

Member Data Documentation

$importAllowed

string[] Fossology\UI\Api\Controllers\ReportController::$importAllowed

private

Initial value:

= [
    'decisionimporter',
    'spdxrdf'
  ]

Allowed report types to be imported.

Definition at line 64 of file ReportController.php.

$reportsAllowed

array Fossology\UI\Api\Controllers\ReportController::$reportsAllowed

private

Initial value:

= array(
    'dep5',
    'spdx2',
    'spdx2tv',
    'readmeoss',
    'unifiedreport',
    'clixml',
    'decisionexporter',
    'cyclonedx'
  )

Allowed agent names to create report

Definition at line 49 of file ReportController.php.

---

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

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