Model to hold analysis settings. More...

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

Public Member Functions
	__construct ($bucket=false, $copyright=false, $ecc=false, $keyword=false, $mimetype=false, $monk=false, $nomos=false, $ojo=false, $reso=false, $pkgagent=false, $compatibility=false, $scanoss=false, $ipra=false, $softwareHeritage=false)

	setUsingArray ($analysisArray, $version=ApiVersion::V1)

	setUsingString ($analysisString)

	getBucket ()

	getCopyright ()

	getEcc ()

	getKeyword ()

	getMime ()

	getMonk ()

	getNomos ()

	getOjo ()

	getScanoss ()

	getReso ()

	getPkgagent ()

	getIpra ()

	getSoftwareHeritage ()

	getCompatibility ()

	setBucket ($bucket)

	setCopyright ($copyright)

	setEcc ($ecc)

	setKeyword ($keyword)

	setMime ($mime)

	setMonk ($monk)

	setNomos ($nomos)

	setOjo ($ojo)

	setScanoss ($scanoss)

	setReso ($reso)

	setPkgagent ($pkgagent)

	setIpra ($ipra)

	setSoftwareHeritage ($softwareHeritage)

	setCompatibility ($compatibility)

	getArray ($version=ApiVersion::V1)

Private Member Functions
	setBooleanProperties ($array, $propertyMap)

Private Attributes
	$bucket

	$copyright

	$ecc

	$keyword

	$mimetype

	$monk

	$nomos

	$ojo

	$scanoss

	$reso

	$pkgagent

	$ipra

	$softwareHeritage

	$compatibility

Detailed Description

Model to hold analysis settings.

Definition at line 20 of file Analysis.php.

Constructor & Destructor Documentation

◆ __construct()

Fossology\UI\Api\Models\Analysis::__construct	(	$bucket = `false`,
		$copyright = `false`,
		$ecc = `false`,
		$keyword = `false`,
		$mimetype = `false`,
		$monk = `false`,
		$nomos = `false`,
		$ojo = `false`,
		$reso = `false`,
		$pkgagent = `false`,
		$compatibility = `false`,
		$scanoss = `false`,
		$ipra = `false`,
		$softwareHeritage = `false`
	)

Analysis constructor.

Parameters

boolean	$bucket
boolean	$copyright
boolean	$ecc
boolean	$keyword
boolean	$mimetype
boolean	$monk
boolean	$nomos
boolean	$pkgagent
boolean	$ojo
boolean	$reso
boolean	$compatibility
boolean	$scanoss
boolean	$ipra
boolean	$softwareHeritage

Definition at line 110 of file Analysis.php.

Member Function Documentation

◆ getArray()

Fossology\UI\Api\Models\Analysis::getArray ( $version = ApiVersion::V1 )

Get the object as an associative array

Returns: array

Definition at line 433 of file Analysis.php.

◆ getBucket()

Fossology\UI\Api\Models\Analysis::getBucket ( )

Returns: boolean

Definition at line 207 of file Analysis.php.

◆ getCompatibility()

Fossology\UI\Api\Models\Analysis::getCompatibility ( )

Returns: bool

Definition at line 311 of file Analysis.php.

◆ getCopyright()

Fossology\UI\Api\Models\Analysis::getCopyright ( )

Returns: boolean

Definition at line 215 of file Analysis.php.

◆ getEcc()

Fossology\UI\Api\Models\Analysis::getEcc ( )

Returns: boolean

Definition at line 223 of file Analysis.php.

◆ getIpra()

Fossology\UI\Api\Models\Analysis::getIpra ( )

Returns: boolean

Definition at line 295 of file Analysis.php.

◆ getKeyword()

Fossology\UI\Api\Models\Analysis::getKeyword ( )

Returns: boolean

Definition at line 231 of file Analysis.php.

◆ getMime()

Fossology\UI\Api\Models\Analysis::getMime ( )

Returns: boolean

Definition at line 239 of file Analysis.php.

◆ getMonk()

Fossology\UI\Api\Models\Analysis::getMonk ( )

Returns: boolean

Definition at line 247 of file Analysis.php.

◆ getNomos()

Fossology\UI\Api\Models\Analysis::getNomos ( )

Returns: boolean

Definition at line 255 of file Analysis.php.

◆ getOjo()

Fossology\UI\Api\Models\Analysis::getOjo ( )

Returns: boolean

Definition at line 263 of file Analysis.php.

◆ getPkgagent()

Fossology\UI\Api\Models\Analysis::getPkgagent ( )

Returns: boolean

Definition at line 287 of file Analysis.php.

◆ getReso()

Fossology\UI\Api\Models\Analysis::getReso ( )

Returns: boolean

Definition at line 279 of file Analysis.php.

◆ getScanoss()

Fossology\UI\Api\Models\Analysis::getScanoss ( )

Returns: boolean

Definition at line 271 of file Analysis.php.

◆ getSoftwareHeritage()

Fossology\UI\Api\Models\Analysis::getSoftwareHeritage ( )

Returns: boolean

Definition at line 303 of file Analysis.php.

◆ setBooleanProperties()

Fossology\UI\Api\Models\Analysis::setBooleanProperties	(	$array,
		$propertyMap
	)

private

Helper function to set boolean properties from array

Parameters

array	$array	Source array containing boolean values
array	$propertyMap	Map of array keys to object properties

Definition at line 134 of file Analysis.php.

◆ setBucket()

Fossology\UI\Api\Models\Analysis::setBucket ( $bucket )

Parameters

boolean $bucket

Definition at line 320 of file Analysis.php.

◆ setCompatibility()

Fossology\UI\Api\Models\Analysis::setCompatibility ( $compatibility )

Parameters

bool $compatibility

Definition at line 424 of file Analysis.php.

◆ setCopyright()

Fossology\UI\Api\Models\Analysis::setCopyright ( $copyright )

Parameters

boolean $copyright

Definition at line 328 of file Analysis.php.

◆ setEcc()

Fossology\UI\Api\Models\Analysis::setEcc ( $ecc )

Parameters

boolean $ecc

Definition at line 336 of file Analysis.php.

◆ setIpra()

Fossology\UI\Api\Models\Analysis::setIpra ( $ipra )

Parameters

boolean $ipra

Definition at line 408 of file Analysis.php.

◆ setKeyword()

Fossology\UI\Api\Models\Analysis::setKeyword ( $keyword )

Parameters

boolean $keyword

Definition at line 344 of file Analysis.php.

◆ setMime()

Fossology\UI\Api\Models\Analysis::setMime ( $mime )

Parameters

boolean $mime

Definition at line 352 of file Analysis.php.

◆ setMonk()

Fossology\UI\Api\Models\Analysis::setMonk ( $monk )

Parameters

boolean $monk

Definition at line 360 of file Analysis.php.

◆ setNomos()

Fossology\UI\Api\Models\Analysis::setNomos ( $nomos )

Parameters

boolean $nomos

Definition at line 368 of file Analysis.php.

◆ setOjo()

Fossology\UI\Api\Models\Analysis::setOjo ( $ojo )

Parameters

boolean $ojo

Definition at line 376 of file Analysis.php.

◆ setPkgagent()

Fossology\UI\Api\Models\Analysis::setPkgagent ( $pkgagent )

Parameters

boolean $package

Definition at line 400 of file Analysis.php.

◆ setReso()

Fossology\UI\Api\Models\Analysis::setReso ( $reso )

Parameters

boolean $reso

Definition at line 392 of file Analysis.php.

◆ setScanoss()

Fossology\UI\Api\Models\Analysis::setScanoss ( $scanoss )

Parameters

boolean $scanoss

Definition at line 384 of file Analysis.php.

◆ setSoftwareHeritage()

Fossology\UI\Api\Models\Analysis::setSoftwareHeritage ( $softwareHeritage )

Parameters

boolean $softwareHeritage

Definition at line 416 of file Analysis.php.

◆ setUsingArray()

Fossology\UI\Api\Models\Analysis::setUsingArray	(	$analysisArray,
		$version = `ApiVersion::V1`
	)

Set the values of Analysis based on associative array

Parameters

array $analysisArray Associative boolean array

Returns: Analysis Current object

Definition at line 148 of file Analysis.php.

◆ setUsingString()

Fossology\UI\Api\Models\Analysis::setUsingString ( $analysisString )

Set the values of Analysis based on string from DB

Parameters

string $analysisString String from DB settings

Returns: Analysis Current object

Definition at line 176 of file Analysis.php.

Member Data Documentation

◆ $bucket

boolean Fossology\UI\Api\Models\Analysis::$bucket

private

Whether to schedule bucket agent or not

Definition at line 26 of file Analysis.php.

◆ $compatibility

boolean Fossology\UI\Api\Models\Analysis::$compatibility

private

Whether to schedule compatibility agent or not

Definition at line 91 of file Analysis.php.

◆ $copyright

boolean Fossology\UI\Api\Models\Analysis::$copyright

private

Whether to schedule copyright agent or not

Definition at line 31 of file Analysis.php.

◆ $ecc

boolean Fossology\UI\Api\Models\Analysis::$ecc

private

Whether to schedule ecc agent or not

Definition at line 36 of file Analysis.php.

◆ $ipra

boolean Fossology\UI\Api\Models\Analysis::$ipra

private

Whether to schedule ipra agent or not

Definition at line 81 of file Analysis.php.

◆ $keyword

boolean Fossology\UI\Api\Models\Analysis::$keyword

private

Whether to schedule keyword agent or not

Definition at line 41 of file Analysis.php.

◆ $mimetype

boolean Fossology\UI\Api\Models\Analysis::$mimetype

private

Whether to schedule mime type agent or not

Definition at line 46 of file Analysis.php.

◆ $monk

boolean Fossology\UI\Api\Models\Analysis::$monk

private

Whether to schedule monk agent or not

Definition at line 51 of file Analysis.php.

◆ $nomos

boolean Fossology\UI\Api\Models\Analysis::$nomos

private

Whether to schedule nomos agent or not

Definition at line 56 of file Analysis.php.

◆ $ojo

boolean Fossology\UI\Api\Models\Analysis::$ojo

private

Whether to schedule ojo agent or not

Definition at line 61 of file Analysis.php.

◆ $pkgagent

boolean Fossology\UI\Api\Models\Analysis::$pkgagent

private

Whether to schedule reso agent or not

Whether to schedule package agent or not

Definition at line 76 of file Analysis.php.

◆ $scanoss

boolean Fossology\UI\Api\Models\Analysis::$scanoss

private

Whether to schedule scanoss agent or not

Definition at line 66 of file Analysis.php.

◆ $softwareHeritage

boolean Fossology\UI\Api\Models\Analysis::$softwareHeritage

private

Whether to schedule software heritage agent or not

Definition at line 86 of file Analysis.php.

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

src/www/ui/api/Models/Analysis.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getArray()

◆ getBucket()

◆ getCompatibility()

◆ getCopyright()

◆ getEcc()

◆ getIpra()

◆ getKeyword()

◆ getMime()

◆ getMonk()

◆ getNomos()

◆ getOjo()

◆ getPkgagent()

◆ getReso()

◆ getScanoss()

◆ getSoftwareHeritage()

◆ setBooleanProperties()

◆ setBucket()

◆ setCompatibility()

◆ setCopyright()

◆ setEcc()

◆ setIpra()

◆ setKeyword()

◆ setMime()

◆ setMonk()

◆ setNomos()

◆ setOjo()

◆ setPkgagent()

◆ setReso()

◆ setScanoss()

◆ setSoftwareHeritage()

◆ setUsingArray()

◆ setUsingString()

Member Data Documentation

◆ $bucket

◆ $compatibility

◆ $copyright

◆ $ecc

◆ $ipra

◆ $keyword

◆ $mimetype

◆ $monk

◆ $nomos

◆ $ojo

◆ $pkgagent

◆ $scanoss

◆ $softwareHeritage