Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
PluginManagementHandler Class Reference
Inheritance diagram for PluginManagementHandler:
ManagerHandler Handler PKPHandler

Public Member Functions

 _checkIfNewer ($productType, $productName, $newVersion)
 
 _deletePlugin ($request, $category, $plugin)
 
 _installPlugin ($request, $path, &$templateMgr)
 
 _setBreadcrumbs ($request, $subclass=false, $category=null)
 
 _setConnectionParams ()
 
 _showDeleteForm ($request, $category, $plugin)
 
 _showInstallForm ($request)
 
 _showUpgradeForm ($request, $category, $plugin)
 
 _upgradePlugin ($request, $path, &$templateMgr, $category, $plugin)
 
 _uploadPlugin ($request, $function, $category=null, $plugin=null)
 
 managePlugins ($args, &$request)
 
 PluginManagementHandler ()
 
- Public Member Functions inherited from ManagerHandler
 email ($args)
 
 index ()
 
 ManagerHandler ()
 
retrieveRoleAssignmentPreferences ($journalId)
 
 setupTemplate ($subclass=false)
 
- Public Member Functions inherited from PKPHandler
 addCheck (&$handlerValidator)
 
 addPolicy (&$authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize (&$request, &$args, $roleAssignments)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getLoginExemptions ()
 
getRangeInfo ($rangeName, $contextData=null)
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 hashPageContext ($contextData=array())
 
 index ()
 
 initialize (&$request, $args=null)
 
 PKPHandler ()
 
 requireSSL ()
 
 setDispatcher (&$dispatcher)
 
 setId ($id)
 
 validate ($requiredContexts=null, $request=null)
 

Detailed Description

Handle requests for installing/upgrading/deleting plugins.

Definition at line 27 of file PluginManagementHandler.inc.php.

Member Function Documentation

PluginManagementHandler::_checkIfNewer (   $productType,
  $productName,
  $newVersion 
)

Checks to see if local version of plugin is newer than installed version

Parameters
$productTypestring Product type of plugin
$productNamestring Product name of plugin
$newVersionVersion Version object of plugin to check against database
Returns
boolean

Definition at line 441 of file PluginManagementHandler.inc.php.

References DAORegistry\getDAO().

Referenced by _installPlugin(), and _upgradePlugin().

PluginManagementHandler::_deletePlugin (   $request,
  $category,
  $plugin 
)

Delete a plugin from the system

Parameters
$requestPKPRequest
$categorystring
$pluginstring

Definition at line 393 of file PluginManagementHandler.inc.php.

References _setBreadcrumbs(), Core\getBaseDir(), PluginRegistry\getCategories(), DAORegistry\getDAO(), ManagerHandler\setupTemplate(), and PKPHandler\validate().

Referenced by managePlugins().

PluginManagementHandler::_installPlugin (   $request,
  $path,
$templateMgr 
)

Installs the uploaded plugin

Parameters
$requestPKPRequest
$pathstring path to plugin Directory
$templateMgrreference to template manager
Returns
boolean

Definition at line 212 of file PluginManagementHandler.inc.php.

References _checkIfNewer(), _setBreadcrumbs(), _setConnectionParams(), Core\getBaseDir(), DAORegistry\getDAO(), VersionCheck\getValidPluginVersionInfo(), and PKPHandler\validate().

Referenced by _uploadPlugin().

PluginManagementHandler::_setBreadcrumbs (   $request,
  $subclass = false,
  $category = null 
)

Set the page's breadcrumbs

Parameters
$requestPKPRequest
$subclassboolean
$categorystring

Definition at line 456 of file PluginManagementHandler.inc.php.

Referenced by _deletePlugin(), _installPlugin(), _showDeleteForm(), _showInstallForm(), _showUpgradeForm(), and _upgradePlugin().

PluginManagementHandler::_setConnectionParams ( )

Load database connection parameters into an array (needed for upgrade).

Returns
array

Definition at line 494 of file PluginManagementHandler.inc.php.

References Config\getVar().

Referenced by _installPlugin(), and _upgradePlugin().

PluginManagementHandler::_showDeleteForm (   $request,
  $category,
  $plugin 
)

Confirm deletion of plugin.

Parameters
$requestPKPRequest
$categorystring
$pluginstring

Definition at line 116 of file PluginManagementHandler.inc.php.

References _setBreadcrumbs(), ManagerHandler\setupTemplate(), and PKPHandler\validate().

Referenced by managePlugins().

PluginManagementHandler::_showInstallForm (   $request)

Show plugin installation form.

Parameters
$requestPKPRequest

Definition at line 76 of file PluginManagementHandler.inc.php.

References _setBreadcrumbs(), ManagerHandler\setupTemplate(), and PKPHandler\validate().

Referenced by managePlugins().

PluginManagementHandler::_showUpgradeForm (   $request,
  $category,
  $plugin 
)

Show form to select plugin for upgrade.

Parameters
$requestPKPRequest
$categorystring
$pluginstring

Definition at line 96 of file PluginManagementHandler.inc.php.

References _setBreadcrumbs(), ManagerHandler\setupTemplate(), and PKPHandler\validate().

Referenced by managePlugins().

PluginManagementHandler::_upgradePlugin (   $request,
  $path,
$templateMgr,
  $category,
  $plugin 
)

Upgrade a plugin to a newer version from the user's filesystem

Parameters
$requestPKPRequest
$pathstring path to plugin Directory
$templateMgrreference to template manager
$categorystring
$pluginstring
Returns
boolean

Definition at line 294 of file PluginManagementHandler.inc.php.

References _checkIfNewer(), _setBreadcrumbs(), _setConnectionParams(), Core\getBaseDir(), DAORegistry\getDAO(), VersionCheck\getValidPluginVersionInfo(), and PKPHandler\validate().

Referenced by _uploadPlugin().

PluginManagementHandler::_uploadPlugin (   $request,
  $function,
  $category = null,
  $plugin = null 
)

Decompress uploaded plugin and install in the correct plugin directory.

Parameters
$requestPKPRequest
$functionstring type of operation to perform after upload ('upgrade' or 'install')
$categorystring the category of the uploaded plugin (upgrade only)
$pluginstring the name of the uploaded plugin (upgrade only)

Definition at line 139 of file PluginManagementHandler.inc.php.

References _installPlugin(), _upgradePlugin(), Config\getVar(), String\regexp_match_get(), ManagerHandler\setupTemplate(), and PKPHandler\validate().

Referenced by managePlugins().

PluginManagementHandler::managePlugins (   $args,
$request 
)

Display a list of plugins along with management options.

Parameters
$argsarray
$requestPKPRequest

Definition at line 40 of file PluginManagementHandler.inc.php.

References _deletePlugin(), _showDeleteForm(), _showInstallForm(), _showUpgradeForm(), _uploadPlugin(), ManagerHandler\setupTemplate(), and PKPHandler\validate().

PluginManagementHandler::PluginManagementHandler ( )

Constructor

Definition at line 31 of file PluginManagementHandler.inc.php.


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