FOSSology  3.2.0rc1
Open Source License Compliance by Open Source Software
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
Fossology\Lib\Plugin\AgentPlugin Class Reference
Inheritance diagram for Fossology\Lib\Plugin\AgentPlugin:
Inheritance graph
Collaboration diagram for Fossology\Lib\Plugin\AgentPlugin:
Collaboration graph

Public Member Functions

 execute ()
 
 postInstall ()
 
 preInstall ()
 
 unInstall ()
 
 getName ()
 
 AgentHasResults ($uploadId=0)
 
 AgentAdd ($jobId, $uploadId, &$errorMsg, $dependencies=array(), $arguments=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)
 
 implicitAgentAdd ($jobId, $uploadId, &$errorMsg, $dependency)
 

Detailed Description

Definition at line 21 of file AgentPlugin.php.

Member Function Documentation

Fossology\Lib\Plugin\AgentPlugin::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

Definition at line 83 of file AgentPlugin.php.

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

Definition at line 67 of file AgentPlugin.php.

Fossology\Lib\Plugin\AgentPlugin::doAgentAdd (   $jobId,
  $uploadId,
&  $errorMsg,
  $dependencies,
  $jqargs = "",
  $jq_cmd_args = null 
)
protected
Parameters
int$jobId
int$uploadId
&string$errorMsg - error message on failure
array$dependencies
string | null$jqargs(optional) jobqueue.jq_args
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 110 of file AgentPlugin.php.

Fossology\Lib\Plugin\AgentPlugin::getName ( )
Returns
string

Implements Fossology\Lib\Plugin\Plugin.

Definition at line 55 of file AgentPlugin.php.

Fossology\Lib\Plugin\AgentPlugin::implicitAgentAdd (   $jobId,
  $uploadId,
&  $errorMsg,
  $dependency 
)
protected
Parameters
int$jobId
int$uploadId
&string$errorMsg
mixed$dependency
Returns
int

Definition at line 144 of file AgentPlugin.php.

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