FOSSology  4.4.0
Open Source License Compliance by Open Source Software
Fossology\SpdxTwo\UI\SpdxTwoGeneratorUi Class Reference

Call SPDX2 agent to generate report from UI. More...

Inheritance diagram for Fossology\SpdxTwo\UI\SpdxTwoGeneratorUi:
Inheritance graph
Collaboration diagram for Fossology\SpdxTwo\UI\SpdxTwoGeneratorUi:
Collaboration graph

Public Member Functions

 preInstall ()
 
 scheduleAgent ($groupId, $upload, $outputFormat=self::DEFAULT_OUTPUT_FORMAT, $addUploads=array())
 
- Public Member Functions inherited from Fossology\Lib\Plugin\DefaultPlugin
 __construct ($name, $parameters=array())
 
 getName ()
 
 getVersion ()
 
 getTitle ()
 
 isRequiresLogin ()
 
 getDependency ()
 
 getPluginLevel ()
 
 getDBaccess ()
 
 getState ()
 
 getInitOrder ()
 
 getNoMenu ()
 
 getResponse ()
 
 getObject ($name)
 
 postInstall ()
 
 unInstall ()
 
 execute ()
 
 isLoggedIn ()
 
 __get ($name)
 
 __toString ()
 

Public Attributes

const NAME = 'ui_spdx2'
 Mod name of the plugin.
 
const DEFAULT_OUTPUT_FORMAT = "spdx2"
 Default report format.
 
- Public Attributes inherited from Fossology\Lib\Plugin\DefaultPlugin
const PERMISSION = "permission"
 
const REQUIRES_LOGIN = "requiresLogin"
 
const ENABLE_MENU = "ENABLE_MENU"
 
const LEVEL = "level"
 
const DEPENDENCIES = "dependencies"
 
const INIT_ORDER = "initOrder"
 
const MENU_LIST = "menuList"
 
const MENU_ORDER = "menuOrder"
 
const MENU_TARGET = "menuTarget"
 
const TITLE = "title"
 

Protected Member Functions

 handle (Request $request)
 
 uploadsAdd ($uploads)
 Add multiple uploads to the report. More...
 
 getJobAndJobqueue ($groupId, $upload, $addUploads)
 Get the Job ID and Job queue ID. More...
 
- Protected Member Functions inherited from Fossology\Lib\Plugin\DefaultPlugin
 RegisterMenus ()
 Customize submenus.
 
 render ($templateName, $vars=null, $headers=null)
 
 getDefaultHeaders ()
 
 getDefaultVars ()
 
 mergeWithDefault ($vars)
 
 flushContent ($content)
 

Protected Attributes

 $outputFormat = self::DEFAULT_OUTPUT_FORMAT
 
- Protected Attributes inherited from Fossology\Lib\Plugin\DefaultPlugin
 $container
 
 $renderer
 
 $microMenu
 

Detailed Description

Call SPDX2 agent to generate report from UI.

Definition at line 20 of file SpdxTwoGeneratorUi.php.

Member Function Documentation

◆ getJobAndJobqueue()

Fossology\SpdxTwo\UI\SpdxTwoGeneratorUi::getJobAndJobqueue (   $groupId,
  $upload,
  $addUploads 
)
protected

Get the Job ID and Job queue ID.

Parameters
int$groupId
Upload$upload
array$addUploads
Exceptions
Exception
Returns
array JobID, JobQuqueID

Definition at line 138 of file SpdxTwoGeneratorUi.php.

◆ handle()

Fossology\SpdxTwo\UI\SpdxTwoGeneratorUi::handle ( Request  $request)
protected

Parameters
Request$request
Returns
Response
See also
Fossology::Lib::Plugin::DefaultPlugin::handle()

Reimplemented from Fossology\Lib\Plugin\DefaultPlugin.

Definition at line 68 of file SpdxTwoGeneratorUi.php.

◆ preInstall()

Fossology\SpdxTwo\UI\SpdxTwoGeneratorUi::preInstall ( )

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

Reimplemented from Fossology\Lib\Plugin\DefaultPlugin.

Definition at line 48 of file SpdxTwoGeneratorUi.php.

◆ scheduleAgent()

Fossology\SpdxTwo\UI\SpdxTwoGeneratorUi::scheduleAgent (   $groupId,
  $upload,
  $outputFormat = self::DEFAULT_OUTPUT_FORMAT,
  $addUploads = array() 
)

Schedules spdx agent to generate report based of outputFormat

Parameters
int$groupId
Upload$upload
string$outputFormat
array$addUploads
Returns
array|number[] Job id and job queue id
Exceptions
Exception

Definition at line 210 of file SpdxTwoGeneratorUi.php.

◆ uploadsAdd()

Fossology\SpdxTwo\UI\SpdxTwoGeneratorUi::uploadsAdd (   $uploads)
protected

Add multiple uploads to the report.

Parameters
array$uploadsList of upload IDs
Returns
string

Definition at line 122 of file SpdxTwoGeneratorUi.php.

Member Data Documentation

◆ $outputFormat

string Fossology\SpdxTwo\UI\SpdxTwoGeneratorUi::$outputFormat = self::DEFAULT_OUTPUT_FORMAT
protected

Report format in use

Definition at line 27 of file SpdxTwoGeneratorUi.php.


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