FOSSology  4.4.0
Open Source License Compliance by Open Source Software
Fossology\DecisionImporter\UI\FoDecisionImporter Class Reference
Inheritance diagram for Fossology\DecisionImporter\UI\FoDecisionImporter:
Inheritance graph
Collaboration diagram for Fossology\DecisionImporter\UI\FoDecisionImporter:
Collaboration graph

Public Member Functions

 preInstall ()
 
 setAdditionalJqCmdArgs (Request $request)
 
 addReport (UploadedFile $report)
 
- 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 NAME = 'agent_fodecisionimporter'
 Plugin mod name.
 
- 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
 

Private Attributes

const KEYS
 Additional keys used by agent. More...
 

Additional Inherited Members

- 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 27 of file FoDecisionImporter.php.

Member Function Documentation

◆ addReport()

Fossology\DecisionImporter\UI\FoDecisionImporter::addReport ( UploadedFile  $report)

Save the uploaded file at correct path and add it to the CLI argument.

Parameters
UploadedFile$report
Returns
string
Exceptions
UnexpectedValueException

Definition at line 77 of file FoDecisionImporter.php.

◆ preInstall()

Fossology\DecisionImporter\UI\FoDecisionImporter::preInstall ( )

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

Reimplemented from Fossology\Lib\Plugin\AgentPlugin.

Definition at line 48 of file FoDecisionImporter.php.

◆ setAdditionalJqCmdArgs()

Fossology\DecisionImporter\UI\FoDecisionImporter::setAdditionalJqCmdArgs ( Request  $request)

Translate the data from UI request to CLI arguments.

Parameters
Request$request
Returns
string

Definition at line 58 of file FoDecisionImporter.php.

Member Data Documentation

◆ KEYS

const Fossology\DecisionImporter\UI\FoDecisionImporter::KEYS
private
Initial value:
= [
'userselect'
]

Additional keys used by agent.

Definition at line 31 of file FoDecisionImporter.php.


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