Fossology\Lib\Report\LicenseClearedGetter Class Reference

Inheritance diagram for Fossology\Lib\Report\LicenseClearedGetter:

Collaboration diagram for Fossology\Lib\Report\LicenseClearedGetter:

Public Member Functions
	getCleared ($uploadId, $objectAgent, $groupId=null, $extended=true, $agentCall=null, $isUnifiedReport=false)
	setOnlyComments ($displayOnlyCommentedLicenseClearings)
	setOnlyAcknowledgements ($displayOnlyAcknowledgements)
	checkLicenseId ($licenses1, $licenses2)
	callback to compare licenses More...
	updateIdentifiedGlobalLicenses ($licensesMain, $licenses)
	Copy identified global licenses. More...
Public Member Functions inherited from Fossology\Lib\Report\ClearedGetterCommon
	__construct ($groupBy="content")
	getCliArgs ()
	getUploadId ()
	getUserId ()
	getGroupId ()
	getLicenseHistogramForReport ($uploadId, $groupId)
	cJson ($uploadId, $groupId=null)
	cJsonHist ($uploadId, $groupId=null)

Protected Member Functions
	groupStatementsSpecial ($ungrupedStatements, $objectAgent)
	getCachedLicenseText ($licenseId, $groupId)
	getCachedLicenseRisk ($licenseId, $groupId)
	getHistogram ($uploadId, $groupId)
Protected Member Functions inherited from Fossology\Lib\Report\ClearedGetterCommon
	changeTreeIdsToPaths (&$ungrupedStatements, $uploadTreeTableName, $uploadId)
	groupUserFindings ($findings)
	Group the content inside a array. More...
	groupStatements ($ungrupedStatements, $extended, $agentCall, $isUnifiedReport, $objectAgent)
	getStatements ($uploadId, $uploadTreeTableName, $groupId=null)

Protected Attributes
	$agentNames = AgentRef::AGENT_LIST
Protected Attributes inherited from Fossology\Lib\Report\ClearedGetterCommon
	$uploadDao
	$treeDao

Private Attributes
	$onlyComments = false
	$onlyAcknowledgements = false
	$clearingDao
	$licenseDao
	$agentDao
	$licenseCache = array()

Detailed Description

Definition at line 21 of file LicenseClearedGetter.php.

Member Function Documentation

checkLicenseId()

Fossology\Lib\Report\LicenseClearedGetter::checkLicenseId	(		$licenses1,
			$licenses2
	)

callback to compare licenses

Parameters

array	$licenses1
array	$licenses2

Returns

int difference of license ids

Definition at line 275 of file LicenseClearedGetter.php.

getCachedLicenseRisk()

Fossology\Lib\Report\LicenseClearedGetter::getCachedLicenseRisk (   $licenseId,   $groupId  )

protected

Parameters

int

$licenseId,$groupId

Returns

int|string

Definition at line 214 of file LicenseClearedGetter.php.

getCachedLicenseText()

Fossology\Lib\Report\LicenseClearedGetter::getCachedLicenseText (   $licenseId,   $groupId  )

protected

Parameters

int

$licenseId

Returns

License

Definition at line 197 of file LicenseClearedGetter.php.

getCleared()

Fossology\Lib\Report\LicenseClearedGetter::getCleared	(		$uploadId,
			$objectAgent,
			$groupId = null,
			$extended = true,
			$agentCall = null,
			$isUnifiedReport = false
	)

Override of getCleared() to handle acknowledgement grouping

See also

Fossology::Lib::Report::ClearedGetterCommon::getCleared()

Reimplemented from Fossology\Lib\Report\ClearedGetterCommon.

Definition at line 112 of file LicenseClearedGetter.php.

getHistogram()

Fossology\Lib\Report\LicenseClearedGetter::getHistogram (   $uploadId,   $groupId  )

protected

Parameters

int

$uploadId,$groupId

Returns

array scannerLicenseHistogram, editedLicensesHist

Definition at line 231 of file LicenseClearedGetter.php.

groupStatementsSpecial()

Fossology\Lib\Report\LicenseClearedGetter::groupStatementsSpecial (   $ungrupedStatements,   $objectAgent  )

protected

Group acknowledgement statements

Parameters

array	$ungrupedStatements
Agent	$objectAgent

Returns

array

Definition at line 133 of file LicenseClearedGetter.php.

setOnlyAcknowledgements()

Fossology\Lib\Report\LicenseClearedGetter::setOnlyAcknowledgements

(

$displayOnlyAcknowledgements

)

Parameters

boolean

$displayOnlyAcknowledgements

Definition at line 187 of file LicenseClearedGetter.php.

setOnlyComments()

Fossology\Lib\Report\LicenseClearedGetter::setOnlyComments

(

$displayOnlyCommentedLicenseClearings

)

Parameters

boolean

$displayOnlyCommentedLicenseClearings

Definition at line 178 of file LicenseClearedGetter.php.

updateIdentifiedGlobalLicenses()

Fossology\Lib\Report\LicenseClearedGetter::updateIdentifiedGlobalLicenses	(		$licensesMain,
			$licenses
	)

Copy identified global licenses.

Parameters

array	$licensesMain
array	$licenses

Returns

array $licensesMain $licenses with identified global license

Definition at line 286 of file LicenseClearedGetter.php.

---

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

• src/lib/php/Report/LicenseClearedGetter.php