Fossology\UI\Api\Models\ScanOptions Class Reference

Model to hold add settings for new scan. More...

Collaboration diagram for Fossology\UI\Api\Models\ScanOptions:

Public Member Functions
	__construct ($analysis, $reuse, $decider, $scancode)
	getArray ()
	scheduleAgents ($folderId, $uploadId, $newUpload=true)

Private Member Functions
	prepareAgents (Request &$request)
	prepareReuser (Request &$request)
	prepareDecider (Request &$request)
	prepareScancode (Request &$request)

Private Attributes
	$analysis
	$reuse
	$decider
	$scancode

Detailed Description

Model to hold add settings for new scan.

Definition at line 29 of file ScanOptions.php.

Constructor & Destructor Documentation

__construct()

Fossology\UI\Api\Models\ScanOptions::__construct	(		$analysis,
			$reuse,
			$decider,
			$scancode
	)

ScanOptions constructor.

Parameters

Analysis	$analysis
Reuser	$reuse
Decider	$decider
Scancode	$scancode

Definition at line 58 of file ScanOptions.php.

Member Function Documentation

getArray()

Fossology\UI\Api\Models\ScanOptions::getArray

(

)

Get ScanOptions elements as associative array

Returns

array

Definition at line 70 of file ScanOptions.php.

prepareAgents()

Fossology\UI\Api\Models\ScanOptions::prepareAgents ( Request &  $request )

private

Prepare agentsToAdd string based on Analysis settings.

Parameters

Request

$request

Request object to manipulate

Returns

string[]

Definition at line 128 of file ScanOptions.php.

prepareDecider()

Fossology\UI\Api\Models\ScanOptions::prepareDecider ( Request &  $request )

private

Prepare Request object based on Decider settings.

Parameters

Request

$request

Definition at line 184 of file ScanOptions.php.

prepareReuser()

Fossology\UI\Api\Models\ScanOptions::prepareReuser ( Request &  $request )

private

Prepare Request object based on Reuser settings.

Parameters

Request

$request

Definition at line 155 of file ScanOptions.php.

prepareScancode()

Fossology\UI\Api\Models\ScanOptions::prepareScancode ( Request &  $request )

private

Prepare Request object based on Scancode settings.

Parameters

Request

$request

Definition at line 214 of file ScanOptions.php.

scheduleAgents()

Fossology\UI\Api\Models\ScanOptions::scheduleAgents	(		$folderId,
			$uploadId,
			$newUpload = true
	)

Schedule the agents for the given upload in the given folder based on current settings.

Parameters

integer	$folderId	Folder with the upload
integer	$uploadId	Upload to be scanned
boolean	$newUpload	If true, do not check if the folder contains the upload. Should be false for existing uploads.

Returns

\Fossology\UI\Api\Models\Info

Exceptions

HttpNotFoundException	If the folder does not contain the upload
HttpForbiddenException	If the user does not have write access to the upload

Definition at line 91 of file ScanOptions.php.

Member Data Documentation

$analysis

Analysis Fossology\UI\Api\Models\ScanOptions::$analysis

private

Analysis settings

Definition at line 35 of file ScanOptions.php.

$decider

Decider Fossology\UI\Api\Models\ScanOptions::$decider

private

Decider settings

Definition at line 45 of file ScanOptions.php.

$reuse

Reuser Fossology\UI\Api\Models\ScanOptions::$reuse

private

Reuser settings

Definition at line 40 of file ScanOptions.php.

$scancode

Scancode Fossology\UI\Api\Models\ScanOptions::$scancode

private

Scancode settings

Definition at line 50 of file ScanOptions.php.

---

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

• src/www/ui/api/Models/ScanOptions.php