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

Public Member Functions

 RegisterMenus ()
 Customize submenus.
 
 handle (Request $request)
 
 renderString ($templateName, $vars)
 
- 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)
 
 preInstall ()
 
 postInstall ()
 
 unInstall ()
 
 execute ()
 
 isLoggedIn ()
 
 __get ($name)
 
 __toString ()
 

Public Attributes

const NAME = "sh-agent"
 UI mod name.
 
 $AgentName = "agent_softwareHeritage"
 
- 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 Attributes

 $agentNames = array('softwareHeritage' => 'SH')
 
- Protected Attributes inherited from Fossology\Lib\Plugin\DefaultPlugin
 $container
 
 $renderer
 
 $microMenu
 

Private Member Functions

 showUploadHist (ItemTreeBounds $itemTreeBounds)
 Given an $Uploadtree_pk, display: More...
 
 countFileListing (ItemTreeBounds $itemTreeBounds)
 

Private Attributes

 $uploadtree_tablename = ""
 
 $uploadDao
 
 $dbManeger
 
 $shDao
 
 $agentDao
 

Additional Inherited Members

- Protected Member Functions inherited from Fossology\Lib\Plugin\DefaultPlugin
 render ($templateName, $vars=null, $headers=null)
 
 getDefaultHeaders ()
 
 getDefaultVars ()
 
 mergeWithDefault ($vars)
 
 flushContent ($content)
 

Detailed Description

Definition at line 23 of file softwareHeritage-plugin.php.

Member Function Documentation

◆ countFileListing()

Fossology\SoftwareHeritage\UI\softwareHeritagePlugin::countFileListing ( ItemTreeBounds  $itemTreeBounds)
private
Parameters
ItemTreeBounds$itemTreeBounds
Returns
array with keys 'isFlat','iTotalRecords','fileSwitch'

Definition at line 172 of file softwareHeritage-plugin.php.

◆ handle()

Fossology\SoftwareHeritage\UI\softwareHeritagePlugin::handle ( Request  $request)
Parameters
Request$request
Returns
Response

Reimplemented from Fossology\Lib\Plugin\DefaultPlugin.

Definition at line 96 of file softwareHeritage-plugin.php.

◆ renderString()

Fossology\SoftwareHeritage\UI\softwareHeritagePlugin::renderString (   $templateName,
  $vars 
)
Parameters
string$templateName
array$vars
Returns
string

Definition at line 187 of file softwareHeritage-plugin.php.

◆ showUploadHist()

Fossology\SoftwareHeritage\UI\softwareHeritagePlugin::showUploadHist ( ItemTreeBounds  $itemTreeBounds)
private

Given an $Uploadtree_pk, display:

  • The histogram for the directory BY LICENSE.
  • The file listing for the directory.

Definition at line 131 of file softwareHeritage-plugin.php.

Member Data Documentation

◆ $dbManeger

DbManager Fossology\SoftwareHeritage\UI\softwareHeritagePlugin::$dbManeger
private

DbManeger object

Definition at line 40 of file softwareHeritage-plugin.php.

◆ $shDao

SoftwareHeritageDao Fossology\SoftwareHeritage\UI\softwareHeritagePlugin::$shDao
private

SoftwareHeritageDao object

Definition at line 46 of file softwareHeritage-plugin.php.

◆ $uploadDao

UploadDao Fossology\SoftwareHeritage\UI\softwareHeritagePlugin::$uploadDao
private

UploadDao object

Definition at line 34 of file softwareHeritage-plugin.php.


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