ModuleInstall/PackageManager/PackageManagerDisplay.php

Show:

inherited

Classes
- \PackageManagerDisplay

Table of Contents

\PackageManagerDisplay
jump to top

Package:

Methods

buildGridOutput(
          Array $tree,  $mod_strings,  $display
              =
              true,  $show_login
              =
              true
          )
        
        :
          String

Build html in order to display the grids relevant for module loader

@param Tree tree - the tree which we are using to display the categories

Parameters

Name	Type	Description
$tree	Array	mod_strings - the local mod strings to display
$mod_strings
$display
$show_login

Returns

Type	Description
String	- a string of html

buildInstallGrid(
           $view
          )
        
        :
          void

Parameters

Name	Type	Description
$view

buildInstalledGrid(
           $mod_strings,  $types
              =
              array('modules')
          )
        
        :
          void

Parameters

Name	Type	Description
$mod_strings
$types

buildLicenseOutput(
           $file
          )
        
        :
          void

This method is meant to be used to display the license agreement inline on the page if the system would like to perform the installation on the same page via an Ajax call

Parameters

Name	Type	Description
$file

buildLoginPanel(
           $mod_strings,  $display_cancel
          )
        
        :
          void

Parameters

Name	Type	Description
$mod_strings
$display_cancel

buildPackageDisplay(
          String $form1, String $hidden_fields, String $form_action, String $types
              =
              array('module'), String $active_form
              =
              'form1',  $install
              =
              false
          )
        
        :
          String

A Static method to Build the display for the package manager

Parameters

Name	Type	Description
$form1	String	form1 - the form to display for manual downloading
$hidden_fields	String	hidden_fields - the hidden fields related to downloading a package
$form_action	String	form_action - the form_action to be used when downloading from the server
$types	String	types - the types of objects we will request from the server
$active_form	String	active_form - the form to display first
$install

Returns

Type	Description
String	- a string of html which will be used to display the forms

buildPatchDisplay(
          String $form1, String $hidden_fields, String $form_action, String $types
              =
              array('module'), String $active_form
              =
              'form1'
          )
        
        :
          String

A Static method to Build the display for the package manager

Parameters

Name	Type	Description
$form1	String	form1 - the form to display for manual downloading
$hidden_fields	String	hidden_fields - the hidden fields related to downloading a package
$form_action	String	form_action - the form_action to be used when downloading from the server
$types	String	types - the types of objects we will request from the server
$active_form	String	active_form - the form to display first

Returns

Type	Description
String	- a string of html which will be used to display the forms

buildTreeView(
          String $div_id,  $isAlive
              =
              true
          )
        
        :
          \Tree

A Static method used to build the initial treeview when the page is first displayed

Parameters

Name	Type	Description
$div_id	String	div_id - this div in which to display the tree
$isAlive

Returns

Type	Description
\Tree	- the tree that is built

createJavascriptModuleArray(
           $modules,  $variable_name
              =
              'mti_data'
          )
        
        :
          void

Parameters

Name	Type	Description
$modules
$variable_name

createJavascriptPackageArray(
           $releases
          )
        
        :
          void

Parameters

Name	Type	Description
$releases

getDisplayScript(
           $install
              =
              false,  $type
              =
              'module',  $releases
              =
              null,  $types
              =
              array(),  $isAlive
              =
              true
          )
        
        :
          String

A Static method used to generate the javascript for the page

Parameters

Name	Type	Description
$install
$type
$releases
$types
$isAlive

Returns

Type	Description
String	- the javascript required for the page

getHeader(
          
          )
        
        :
          void

getLicenseDisplay(
          String $license_file, String $form_action, String $next_step, String $zipFile, String $type, String $manifest, String $modify_field
          )
        
        :
          String

A Static method used to obtain the div for the license

Parameters

Name	Type	Description
$license_file	String	license_file - the path to the license file
$form_action	String	form_action - the form action when accepting the license file
$next_step	String	next_step - the value for the next step in the installation process
$zipFile	String	zipFile - a string representing the path to the zip file
$type	String	type - module/patch....
$manifest	String	manifest - the path to the manifest file
$modify_field	String	modify_field - the field to update when the radio button is changed

Returns

Type	Description
String	- a form used to display the license

ModuleInstall/PackageManager/PackageManagerDisplay.php

\PackageManagerDisplayjump to top

Methods

\PackageManagerDisplay
jump to top