Fossology\UI\Api\Models\Analysis Class Reference

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, $kotoba=false)
	setUsingArray ($analysisArray, $version=ApiVersion::V1)
	setUsingString ($analysisString)
	getBucket ()
	getCopyright ()
	getEcc ()
	getKeyword ()
	getMime ()
	getMonk ()
	getNomos ()
	getOjo ()
	getScanoss ()
	getReso ()
	getPkgagent ()
	getIpra ()
	getSoftwareHeritage ()
	getCompatibility ()
	getkotoba ()
	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)
	setkotoba ($kotoba)
	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
	$kotoba

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,
			$kotoba = 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
boolean	$kotoba

Definition at line 116 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 458 of file Analysis.php.

getBucket()

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

(

)

Returns

boolean

Definition at line 216 of file Analysis.php.

getCompatibility()

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

(

)

Returns

bool

Definition at line 320 of file Analysis.php.

getCopyright()

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

(

)

Returns

boolean

Definition at line 224 of file Analysis.php.

getEcc()

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

(

)

Returns

boolean

Definition at line 232 of file Analysis.php.

getIpra()

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

(

)

Returns

boolean

Definition at line 304 of file Analysis.php.

getKeyword()

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

(

)

Returns

boolean

Definition at line 240 of file Analysis.php.

getkotoba()

Fossology\UI\Api\Models\Analysis::getkotoba

(

)

Returns

boolean

Definition at line 328 of file Analysis.php.

getMime()

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

(

)

Returns

boolean

Definition at line 248 of file Analysis.php.

getMonk()

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

(

)

Returns

boolean

Definition at line 256 of file Analysis.php.

getNomos()

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

(

)

Returns

boolean

Definition at line 264 of file Analysis.php.

getOjo()

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

(

)

Returns

boolean

Definition at line 272 of file Analysis.php.

getPkgagent()

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

(

)

Returns

boolean

Definition at line 296 of file Analysis.php.

getReso()

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

(

)

Returns

boolean

Definition at line 288 of file Analysis.php.

getScanoss()

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

(

)

Returns

boolean

Definition at line 280 of file Analysis.php.

getSoftwareHeritage()

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

(

)

Returns

boolean

Definition at line 312 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 141 of file Analysis.php.

setBucket()

Fossology\UI\Api\Models\Analysis::setBucket

(

$bucket

)

Parameters

boolean

$bucket

Definition at line 337 of file Analysis.php.

setCompatibility()

Fossology\UI\Api\Models\Analysis::setCompatibility

(

$compatibility

)

Parameters

bool

$compatibility

Definition at line 441 of file Analysis.php.

setCopyright()

Fossology\UI\Api\Models\Analysis::setCopyright

(

$copyright

)

Parameters

boolean

$copyright

Definition at line 345 of file Analysis.php.

setEcc()

Fossology\UI\Api\Models\Analysis::setEcc

(

$ecc

)

Parameters

boolean

$ecc

Definition at line 353 of file Analysis.php.

setIpra()

Fossology\UI\Api\Models\Analysis::setIpra

(

$ipra

)

Parameters

boolean

$ipra

Definition at line 425 of file Analysis.php.

setKeyword()

Fossology\UI\Api\Models\Analysis::setKeyword

(

$keyword

)

Parameters

boolean

$keyword

Definition at line 361 of file Analysis.php.

setkotoba()

Fossology\UI\Api\Models\Analysis::setkotoba

(

$kotoba

)

Parameters

boolean

$kotoba

Definition at line 449 of file Analysis.php.

setMime()

Fossology\UI\Api\Models\Analysis::setMime

(

$mime

)

Parameters

boolean

$mime

Definition at line 369 of file Analysis.php.

setMonk()

Fossology\UI\Api\Models\Analysis::setMonk

(

$monk

)

Parameters

boolean

$monk

Definition at line 377 of file Analysis.php.

setNomos()

Fossology\UI\Api\Models\Analysis::setNomos

(

$nomos

)

Parameters

boolean

$nomos

Definition at line 385 of file Analysis.php.

setOjo()

Fossology\UI\Api\Models\Analysis::setOjo

(

$ojo

)

Parameters

boolean

$ojo

Definition at line 393 of file Analysis.php.

setPkgagent()

Fossology\UI\Api\Models\Analysis::setPkgagent

(

$pkgagent

)

Parameters

boolean

$package

Definition at line 417 of file Analysis.php.

setReso()

Fossology\UI\Api\Models\Analysis::setReso

(

$reso

)

Parameters

boolean

$reso

Definition at line 409 of file Analysis.php.

setScanoss()

Fossology\UI\Api\Models\Analysis::setScanoss

(

$scanoss

)

Parameters

boolean

$scanoss

Definition at line 401 of file Analysis.php.

setSoftwareHeritage()

Fossology\UI\Api\Models\Analysis::setSoftwareHeritage

(

$softwareHeritage

)

Parameters

boolean

$softwareHeritage

Definition at line 433 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 155 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 184 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.

$kotoba

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

private

Whether to schedule kotoba agent or not

Definition at line 96 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