FOSSology  4.4.0
Open Source License Compliance by Open Source Software
LicenseListFiles Class Reference
Inheritance diagram for LicenseListFiles:
Inheritance graph
Collaboration diagram for LicenseListFiles:
Collaboration graph

Public Member Functions

 __construct ()
 base constructor. Most plugins will just use this More...
 
 RegisterMenus ()
 Customize submenus.
 
 Output ()
 Display the loaded menu and plugins. More...
 
- Public Member Functions inherited from FO_Plugin
 Install ()
 This function (when defined) is only called when the plugin is first installed. It should make sure all requirements are available and create anything it needs to run. It returns 0 on success, non-zero on failure. A failed install is not inserted in the system. More...
 
 Remove ()
 This function (when defined) is only called once, when the plugin is removed. It should uninstall and remove all items that are only used by this plugin. There should be no residues – if the plugin is ever installed again, it should act like a clean install. Thus, any DB, files, or state variables specific to this plugin must be removed. This function must always succeed.
 
 Initialize ()
 dummy stub till all references are removed.
 
 PostInitialize ()
 This function is called before the plugin is used and after all plugins have been initialized. If there is any initialization step that is dependent on other plugins, put it here. More...
 
 Destroy ()
 This is a destructor called after the plugin is no longer needed. It should assume that PostInitialize() was already run one time (this session) and succeeded. This function must always succeed.
 
 OutputOpen ()
 This function is called when user output is requested. This function is responsible for assigning headers.
 
 OutputUnSet ()
 Similar to OutputClose, this ends the output type for this object. However, this does NOT change any global settings. This is called when this object is a dependency for another object.
 
 getResponse ()
 
 getTemplateName ()
 
 renderString ($templateName, $vars=null)
 
 renderScripts ($scripts)
 Render JavaScript in the template's footer. More...
 
 getRequest ()
 
 execute ()
 
 preInstall ()
 
 postInstall ()
 
 unInstall ()
 
 getName ()
 
 __toString ()
 

Protected Member Functions

 countFilesWithLicense ($agent_pk, $rf_shortname, $uploadtree_pk, $tag_pk, $uploadtree_tablename)
 Cloned from commen-license-file.php to refactor it. More...
 
- Protected Member Functions inherited from FO_Plugin
 render ($templateName, $vars=null)
 

Protected Attributes

 $agentNames = AgentRef::AGENT_LIST
 
- Protected Attributes inherited from FO_Plugin
 $microMenu
 
 $renderer
 
 $vars = array()
 

Private Attributes

 $dbManager
 
 $uploadDao
 
 $licenseDao
 
 $agentDao
 

Additional Inherited Members

- Public Attributes inherited from FO_Plugin
 $State = PLUGIN_STATE_INVALID
 
 $Name = ""
 
 $Version = "1.0"
 
 $Title = ""
 
 $DBaccess = PLUGIN_DB_NONE
 
 $LoginFlag = 0
 
 $NoMenu = 0
 
 $NoHeader = 0
 
 $PluginLevel = 10
 
 $Dependency = array()
 
 $InitOrder = 0
 
 $MenuList = NULL
 
 $MenuOrder = 0
 
 $MenuTarget = NULL
 
 $OutputType = "HTML"
 
 $OutputToStdout = 0
 

Detailed Description

Definition at line 23 of file ui-license-list-files.php.

Constructor & Destructor Documentation

◆ __construct()

LicenseListFiles::__construct ( )

base constructor. Most plugins will just use this

Makes sure the plugin is in the correct state. If so, the plugin is inserted into the Plugins data structure.

The constructor assumes that Install() was already run one time (possibly years ago and not during this object's creation).

Returns
true on success, false on failure.

On failure the plugin is not used by the system. NOTE: This function must NOT assume that other plugins are installed. See PostInitialize.

Reimplemented from FO_Plugin.

Definition at line 40 of file ui-license-list-files.php.

Member Function Documentation

◆ countFilesWithLicense()

LicenseListFiles::countFilesWithLicense (   $agent_pk,
  $rf_shortname,
  $uploadtree_pk,
  $tag_pk,
  $uploadtree_tablename 
)
protected

Cloned from commen-license-file.php to refactor it.

Parameters
$agent_pk- agent id or array(agent id)
$rf_shortname- short name of one license, like GPL, APSL, MIT, ...
$uploadtree_pk- sets scope of request
$uploadtree_tablename
Returns
Array "count"=>{total number of pfiles}, "unique"=>{number of unique pfiles}

Definition at line 270 of file ui-license-list-files.php.

◆ Output()

LicenseListFiles::Output ( )

Display the loaded menu and plugins.

should delete $filesresult yourself

sorting by ufile_name from DB, then reorder the duplicates indented

Reimplemented from FO_Plugin.

Definition at line 78 of file ui-license-list-files.php.


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