Fossology\Lib\Plugin\AgentPlugin Class Reference

Inheritance diagram for Fossology\Lib\Plugin\AgentPlugin:

Collaboration diagram for Fossology\Lib\Plugin\AgentPlugin:

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

Public Attributes
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
	doAgentAdd ($jobId, $uploadId, &$errorMsg, $dependencies, $jqargs="", $jq_cmd_args=null, $request=null)
	implicitAgentAdd ($jobId, $uploadId, &$errorMsg, $dependency, $request)

Detailed Description

Definition at line 12 of file AgentPlugin.php.

Member Function Documentation

AgentAdd()

Fossology\Lib\Plugin\AgentPlugin::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 in UnpackAgentPlugin, SpashtAgentPlugin, ResoAgentPlugin, Fossology\Ojo\Ui\OjosAgentPlugin, NomosAgentPlugin, MonkAgentPlugin, MonkBulkAgentPlugin, Fossology\DeciderJob\UI\DeciderJobAgentPlugin, KeywordAgentPlugin, EccAgentPlugin, CopyrightAgentPlugin, Fossology\Compatibility\Ui\CompatibilityAgentPlugin, BucketAgentPlugin, and Adj2nestAgentPlugin.

Definition at line 76 of file AgentPlugin.php.

AgentHasResults()

Fossology\Lib\Plugin\AgentPlugin::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 in UnpackAgentPlugin, SpashtAgentPlugin, softwareHeritageAgentPlugin, ScanossAgentPlugin, Fossology\Scancode\Ui\ScancodesAgentPlugin, ResoAgentPlugin, PkgAgentPlugin, Fossology\Ojo\Ui\OjosAgentPlugin, NomosAgentPlugin, Fossology\Ninka\Ui\NinkaAgentPlugin, MonkAgentPlugin, MimetypeAgentPlugin, KeywordAgentPlugin, IpraAgentPlugin, EccAgentPlugin, CopyrightAgentPlugin, Fossology\Compatibility\Ui\CompatibilityAgentPlugin, BucketAgentPlugin, and Adj2nestAgentPlugin.

Definition at line 58 of file AgentPlugin.php.

doAgentAdd()

Fossology\Lib\Plugin\AgentPlugin::doAgentAdd (   $jobId,   $uploadId, &  $errorMsg,   $dependencies,   $jqargs = "",   $jq_cmd_args = null,   $request = null  )

protected

Parameters

int	$jobId
int	$uploadId
string	$errorMsg	- error message on failure
array	$dependencies
string | null	$jqargs	(optional) jobqueue.jq_args
	$jq_cmd_args
Request | null	$request

Returns

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

Definition at line 107 of file AgentPlugin.php.

getName()

Fossology\Lib\Plugin\AgentPlugin::getName

(

)

Returns

string

Implements Fossology\Lib\Plugin\Plugin.

Definition at line 46 of file AgentPlugin.php.

implicitAgentAdd()

Fossology\Lib\Plugin\AgentPlugin::implicitAgentAdd (   $jobId,   $uploadId, &  $errorMsg,   $dependency,   $request  )

protected

Parameters

int	$jobId
int	$uploadId
	&string	$errorMsg
mixed	$dependency
Request | null	$request

Returns

int

Definition at line 144 of file AgentPlugin.php.

---

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

• src/lib/php/Plugin/AgentPlugin.php