Fossology\Compatibility\Ui\CompatibilityAgentPlugin Class Reference

Inheritance diagram for Fossology\Compatibility\Ui\CompatibilityAgentPlugin:

Collaboration diagram for Fossology\Compatibility\Ui\CompatibilityAgentPlugin:

Public Member Functions
	AgentAdd ($jobId, $uploadId, &$errorMsg, $dependencies=[], $arguments=null, $request=null, $unpackArgs=null)
	AgentHasResults ($uploadId=0)
Public Member Functions inherited from Fossology\Lib\Plugin\AgentPlugin
	execute ()
	postInstall ()
	preInstall ()
	unInstall ()
	getName ()
	__toString ()

Private Member Functions
	getCompatibilityDependencies ($request)

Private Attributes
	$compDesc

Additional Inherited Members
Public Attributes inherited from Fossology\Lib\Plugin\AgentPlugin
const	PRE_JOB_QUEUE = 'preJq'
	$AgentName
	$Name = "agent_abstract"
	$Dependency = array()
	$Title = 'how to show checkbox'
	$PluginLevel = 10
	$State = PLUGIN_STATE_READY
	$DBaccess = PLUGIN_DB_WRITE
Protected Member Functions inherited from Fossology\Lib\Plugin\AgentPlugin
	doAgentAdd ($jobId, $uploadId, &$errorMsg, $dependencies, $jqargs="", $jq_cmd_args=null, $request=null)
	implicitAgentAdd ($jobId, $uploadId, &$errorMsg, $dependency, $request)

Detailed Description

Definition at line 15 of file agent-compatibility.php.

Member Function Documentation

AgentAdd()

Fossology\Compatibility\Ui\CompatibilityAgentPlugin::AgentAdd	(		$jobId,
			$uploadId,
		&	$errorMsg,
			$dependencies = [],
			$arguments = null,
			$request = null,
			$unpackArgs = null
	)

Parameters

int	$jobId
int	$uploadId
string	$errorMsg	- error message on failure
array	$dependencies	- array of plugin names representing dependencies.
mixed	$arguments	(ignored if not a string)
Request | null	$request	Symfony request
string	$unpackArgs	Ununpack args from adj2nest

Returns

int

• jqId Successfully queued
• 0 Not queued, latest version of agent has previously run successfully
• -1 Not queued, error, error string in $ErrorMsg

Reimplemented from Fossology\Lib\Plugin\AgentPlugin.

Definition at line 32 of file agent-compatibility.php.

AgentHasResults()

Fossology\Compatibility\Ui\CompatibilityAgentPlugin::AgentHasResults

(

$uploadId = 0

)

Parameters

int

$uploadId

Returns

int

• 0 = no or this agent can be re run multiple times
• 1 = yes, from latest agent version
• 2 = yes, from older agent version

Reimplemented from Fossology\Lib\Plugin\AgentPlugin.

Definition at line 56 of file agent-compatibility.php.

getCompatibilityDependencies()

Fossology\Compatibility\Ui\CompatibilityAgentPlugin::getCompatibilityDependencies (   $request )

private

Parameters

Request | array

$request

Returns

array

Definition at line 65 of file agent-compatibility.php.

Member Data Documentation

$compDesc

Fossology\Compatibility\Ui\CompatibilityAgentPlugin::$compDesc

private

Initial value:

= "Checks licenses found in a file and main license and " .
    "adds red highlight to tree view if licenses fail compatibility rules"

Definition at line 18 of file agent-compatibility.php.

---

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

• src/compatibility/ui/agent-compatibility.php