CopyrightAgentPlugin Class Reference

Create UI plugin for copyright agent. More...

Inheritance diagram for CopyrightAgentPlugin:

Collaboration diagram for CopyrightAgentPlugin:

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

Protected Member Functions
	isAgentIncluded ($dependencies, $agentName)
Protected Member Functions inherited from Fossology\Lib\Plugin\AgentPlugin
	doAgentAdd ($jobId, $uploadId, &$errorMsg, $dependencies, $jqargs="", $jq_cmd_args=null)
	implicitAgentAdd ($jobId, $uploadId, &$errorMsg, $dependency)

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

Detailed Description

Create UI plugin for copyright agent.

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

Member Function Documentation

AgentAdd()

CopyrightAgentPlugin::AgentAdd	(		$jobId,
			$uploadId,
		&	$errorMsg,
			$dependencies = array(),
			$arguments = 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)

Returns

int

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

See also

\Fossology\Lib\Plugin\AgentPlugin::AgentAdd()

Reimplemented from Fossology\Lib\Plugin\AgentPlugin.

Definition at line 39 of file agent-copyright.php.

AgentHasResults()

CopyrightAgentPlugin::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

See also

Fossology::Lib::Plugin::AgentPlugin::AgentHasResults()

Reimplemented from Fossology\Lib\Plugin\AgentPlugin.

Definition at line 30 of file agent-copyright.php.

isAgentIncluded()

CopyrightAgentPlugin::isAgentIncluded (   $dependencies,   $agentName  )

protected

Check if agent already included in the dependency list

Parameters

mixed	$dependencies	Array of job dependencies
string	$agentName	Name of the agent to be checked for

Returns

boolean true if agent already in dependency list else false

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

---

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

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