FOSSology  4.4.0
Open Source License Compliance by Open Source Software
ui_download Class Reference

downlad file(s) More...

Inheritance diagram for ui_download:
Inheritance graph
Collaboration diagram for ui_download:
Collaboration graph

Public Member Functions

 __construct ()
 base constructor. Most plugins will just use this More...
 
 RegisterMenus ()
 Customize submenus.
 
 CheckRestore ($Item, $Filename)
 Called if there is no file. User is queried if they want to reunpack. More...
 
 getResponse ()
 
 getDownload ($path, $name)
 
 getReport ($jobId)
 
- 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.
 
 Output ()
 This function is called when user output is requested. This function is responsible for content. (OutputOpen and Output are separated so one plugin can call another plugin's Output.)
 
 getTemplateName ()
 
 renderString ($templateName, $vars=null)
 
 renderScripts ($scripts)
 Render JavaScript in the template's footer. More...
 
 getRequest ()
 
 execute ()
 
 preInstall ()
 
 postInstall ()
 
 unInstall ()
 
 getName ()
 
 __toString ()
 

Public Attributes

 $NoHTML = 1
 
- 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
 

Protected Member Functions

 downloadFile ($path, $filename)
 
- Protected Member Functions inherited from FO_Plugin
 render ($templateName, $vars=null)
 

Additional Inherited Members

- Protected Attributes inherited from FO_Plugin
 $microMenu
 
 $renderer
 
 $vars = array()
 

Detailed Description

downlad file(s)

Definition at line 22 of file ui-download.php.

Constructor & Destructor Documentation

◆ __construct()

ui_download::__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 26 of file ui-download.php.

Member Function Documentation

◆ CheckRestore()

ui_download::CheckRestore (   $Item,
  $Filename 
)

Called if there is no file. User is queried if they want to reunpack.

Known bug: DOCTYPE "should" be in the HEADER and the HEAD tags should come first. Also, IE will ignore <style>...</style> tags that are NOT in a <head>...</head>block.

Definition at line 53 of file ui-download.php.

◆ downloadFile()

ui_download::downloadFile (   $path,
  $filename 
)
protected

@global type $container

Parameters
string$path
string$filename
Returns
BinaryFileResponse

Definition at line 200 of file ui-download.php.

◆ getDownload()

ui_download::getDownload (   $path,
  $name 
)

Get the file response for a given file path

Parameters
$path
$name
Returns
BinaryFileResponse

Definition at line 227 of file ui-download.php.

◆ getReport()

ui_download::getReport (   $jobId)

Get the file response for a given report job id

Parameters
int$jobId
Returns
BinaryFileResponse
Exceptions
Exception

Definition at line 238 of file ui-download.php.

◆ getResponse()

ui_download::getResponse ( )
Returns
Response

Reimplemented from FO_Plugin.

Definition at line 102 of file ui-download.php.


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