FOSSology  4.4.0
Open Source License Compliance by Open Source Software
Fossology\Agent\Copyright\UI\Xpview Class Reference

Default plugin. More...

Inheritance diagram for Fossology\Agent\Copyright\UI\Xpview:
Inheritance graph
Collaboration diagram for Fossology\Agent\Copyright\UI\Xpview:
Collaboration graph

Public Member Functions

 __construct ($name, $params)
 
 legendBox ()
 Create legend box. More...
 
 RegisterMenus ()
 Customize submenus. More...
 
- Public Member Functions inherited from Fossology\Lib\Plugin\DefaultPlugin
 getName ()
 
 getVersion ()
 
 getTitle ()
 
 isRequiresLogin ()
 
 getDependency ()
 
 getPluginLevel ()
 
 getDBaccess ()
 
 getState ()
 
 getInitOrder ()
 
 getNoMenu ()
 
 getResponse ()
 
 getObject ($name)
 
 preInstall ()
 
 postInstall ()
 
 unInstall ()
 
 execute ()
 
 isLoggedIn ()
 
 __get ($name)
 
 __toString ()
 

Protected Member Functions

 handle (Request $request)
 
 additionalVars ($uploadId, $uploadTreeId, $agentId)
 Get additional variables for a give item. More...
 
 mergeWithDefault ($vars)
 
- Protected Member Functions inherited from Fossology\Lib\Plugin\DefaultPlugin
 render ($templateName, $vars=null, $headers=null)
 
 getDefaultHeaders ()
 
 getDefaultVars ()
 
 flushContent ($content)
 

Protected Attributes

 $optionName
 
 $ajaxAction
 
 $modBack
 
 $uploadDao
 
 $copyrightDao
 
 $agentDao
 
 $highlightRenderer
 
 $decisionTypes
 
 $decisionTableName
 
 $tableName
 
 $agentName
 
 $highlightTypeToStringMap
 
 $typeToHighlightTypeMap
 
 $skipOption
 
 $xptext
 
- Protected Attributes inherited from Fossology\Lib\Plugin\DefaultPlugin
 $container
 
 $renderer
 
 $microMenu
 

Private Member Functions

 responseBad ($vars=array())
 Call on bad uploads. More...
 

Additional Inherited Members

- 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"
 

Detailed Description

Default plugin.

Definition at line 33 of file Xpview.php.

Member Function Documentation

◆ additionalVars()

Fossology\Agent\Copyright\UI\Xpview::additionalVars (   $uploadId,
  $uploadTreeId,
  $agentId 
)
protected

Get additional variables for a give item.

Parameters
int$uploadId
int$uploadTreeId
string$agentId
Returns
array
Todo:
Not implemented

Reimplemented in Fossology\Agent\Copyright\UI\CopyrightView.

Definition at line 208 of file Xpview.php.

◆ handle()

Fossology\Agent\Copyright\UI\Xpview::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 85 of file Xpview.php.

◆ legendBox()

Fossology\Agent\Copyright\UI\Xpview::legendBox ( )

Create legend box.

Returns
string rendered legend box

Definition at line 239 of file Xpview.php.

◆ mergeWithDefault()

Fossology\Agent\Copyright\UI\Xpview::mergeWithDefault (   $vars)
protected

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

Reimplemented from Fossology\Lib\Plugin\DefaultPlugin.

Definition at line 217 of file Xpview.php.

◆ RegisterMenus()

Fossology\Agent\Copyright\UI\Xpview::RegisterMenus ( )

◆ responseBad()

Fossology\Agent\Copyright\UI\Xpview::responseBad (   $vars = array())
private

Call on bad uploads.

Parameters
array$varsExtra vars to load by template
Returns
Response

Definition at line 229 of file Xpview.php.


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