Fossology\UI\Api\Controllers\ReportController Class Reference

Controller for report path. More...

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

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

Public Member Functions
	getReport ($request, $response, $args)
Public Member Functions inherited from Fossology\UI\Api\Controllers\RestController
	__construct ($container)

Private Member Functions
	getUpload ($uploadId)
	buildDownloadPath ($request, $jobId)
	checkReport ($id)

Private Attributes
	$reportsAllowed

Additional Inherited Members
Protected Attributes inherited from Fossology\UI\Api\Controllers\RestController
	$container
	$restHelper
	$dbHelper

Detailed Description

Controller for report path.

Definition at line 37 of file ReportController.php.

Member Function Documentation

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

private

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

Parameters

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

Returns

string The path to download the report

Definition at line 148 of file ReportController.php.

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

Fossology::UI::Api::Models::Info|true

Definition at line 233 of file ReportController.php.

Fossology\UI\Api\Controllers\ReportController::getReport	(		$request,
			$response,
			$args
	)

Get the required report for the required upload

Parameters

ServerRequestInterface	$request
ResponseInterface	$response
array	$args

Returns

ResponseInterface

Definition at line 60 of file ReportController.php.

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

Definition at line 121 of file ReportController.php.

Member Data Documentation

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

private

Initial value:

= array(
    'dep5',
    'spdx2',
    'spdx2tv',
    'readmeoss',
    'unifiedreport'
  )

Allowed agent names to create report

Definition at line 44 of file ReportController.php.

---

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

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