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)
	getArray ()
	scheduleAgents ($folderId, $uploadId)

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

Private Attributes
	$analysis
	$reuse
	$decider

Detailed Description

Model to hold add settings for new scan.

Definition at line 38 of file ScanOptions.php.

Constructor & Destructor Documentation

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

ScanOptions constructor.

Parameters

Analysis	$analysis
Reuser	$reuse
Decider	$decider

Definition at line 62 of file ScanOptions.php.

Member Function Documentation

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

(

)

Get ScanOptions elements as associative array

Returns

array

Definition at line 73 of file ScanOptions.php.

Fossology\UI\Api\Models\ScanOptions::prepareAgents ( )

private

Prepare agentsToAdd string based on Analysis settings.

Returns

string[]

Definition at line 120 of file ScanOptions.php.

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

private

Prepare Request object based on Decider settings.

Parameters

Request

$request

Definition at line 163 of file ScanOptions.php.

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

private

Prepare Request object based on Reuser settings.

Parameters

Request

$request

Definition at line 139 of file ScanOptions.php.

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

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

Returns

Fossology::UI::Api::Models::Info

Definition at line 89 of file ScanOptions.php.

Member Data Documentation

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

private

Analysis settings

Definition at line 44 of file ScanOptions.php.

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

private

Decider settings

Definition at line 54 of file ScanOptions.php.

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

private

Reuser settings

Definition at line 49 of file ScanOptions.php.

---

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

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