FOSSology  4.5.1
Open Source License Compliance by Open Source Software
DeciderAgentPlugin Class Reference

UI plugin for DeciderAgent. More...

Inheritance diagram for DeciderAgentPlugin:
Inheritance graph
Collaboration diagram for DeciderAgentPlugin:
Collaboration graph

Public Member Functions

 renderContent (&$vars)
 Render HTML from template. More...
 
 renderFoot (&$vars)
 Render footer HTML. More...
 
 scheduleAgent ($jobId, $uploadId, &$errorMsg, $request)
 Schedule decider agent. More...
 
 preInstall ()
 
- Public Member Functions inherited from Fossology\Lib\Plugin\AgentPlugin
 execute ()
 
 postInstall ()
 
 unInstall ()
 
 getName ()
 
 AgentHasResults ($uploadId=0)
 
 AgentAdd ($jobId, $uploadId, &$errorMsg, $dependencies=[], $arguments=null, $request=null, $unpackArgs=null)
 
 __toString ()
 

Public Attributes

const RULES_FLAG = "-r"
 
const LICENSE_FLAG = "-t"
 
- 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

 addScannerDependencies (&$dependencies, Request $request)
 Add dependencies on DeciderAgent. More...
 
- 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)
 

Private Member Functions

 getLicenseTypeConf (Request $request)
 

Detailed Description

UI plugin for DeciderAgent.

Definition at line 18 of file DeciderAgentPlugin.php.

Member Function Documentation

◆ addScannerDependencies()

DeciderAgentPlugin::addScannerDependencies ( $dependencies,
Request  $request 
)
protected

Add dependencies on DeciderAgent.

Parameters
array$dependencies
Request$request

Definition at line 162 of file DeciderAgentPlugin.php.

◆ getLicenseTypeConf()

DeciderAgentPlugin::getLicenseTypeConf ( Request  $request)
private

Get license type for decision from request.

Parameters
Request$requestSymfony Request
Returns
string License type if valid, empty string otherwise.

Definition at line 193 of file DeciderAgentPlugin.php.

◆ preInstall()

DeciderAgentPlugin::preInstall ( )

See also
Fossology::Lib::Plugin::AgentPlugin::preInstall()

Reimplemented from Fossology\Lib\Plugin\AgentPlugin.

Definition at line 183 of file DeciderAgentPlugin.php.

◆ renderContent()

DeciderAgentPlugin::renderContent ( $vars)

Render HTML from template.

Parameters
array$varsVariables using in template
Returns
string HTML rendered from agent_decider.html.twig template

Definition at line 38 of file DeciderAgentPlugin.php.

◆ renderFoot()

DeciderAgentPlugin::renderFoot ( $vars)

Render footer HTML.

Parameters
array$varsVariables using in template
Returns
string Footer HTML

Definition at line 59 of file DeciderAgentPlugin.php.

◆ scheduleAgent()

DeciderAgentPlugin::scheduleAgent (   $jobId,
  $uploadId,
$errorMsg,
  $request 
)

Schedule decider agent.

Parameters
int$jobId
int$uploadId
string$errorMsg
Request$requestSession request
Returns
string

Definition at line 72 of file DeciderAgentPlugin.php.


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