PluginManagementHandler Class Reference
[Pages_manager]

Handle requests for installing/upgrading/deleting plugins. More...

Inheritance diagram for PluginManagementHandler:

List of all members.

Public Member Functions
	checkIfNewer ($pluginName, $newVersion)
	deletePlugin ($plugin)
	getPluginCategory ($plugin)
	installPlugin ($path, &$templateMgr)
	managePlugins ($args)
	PluginManagementHandler ()
	setBreadcrumbs ($subclass=false, $category=null)
	setConnectionParams ()
	showDeleteForm ($plugin)
	showInstallForm ()
	showUpgradeForm ($plugin)
	upgradePlugin ($path, &$templateMgr)
	uploadPlugin ($function)

---

Detailed Description

Handle requests for installing/upgrading/deleting plugins.

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

---

Member Function Documentation

PluginManagementHandler.checkIfNewer	(	$	pluginName,
		$	newVersion
	)

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

Parameters:

	$pluginName	string Product name of plugin
	$newVersion	Version Version object of plugin to check against database

Returns:

boolean

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

Referenced by installPlugin(), and upgradePlugin().

PluginManagementHandler.deletePlugin

(

$

plugin

)

Delete a plugin from the system

Parameters:

plugin

string

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

References getPluginCategory(), managePlugins(), setBreadcrumbs(), and ManagerHandler.setupTemplate().

Referenced by managePlugins().

PluginManagementHandler.getPluginCategory

(

$

plugin

)

Get the plugin category from the version.

Parameters:

string

Returns:

string

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

Referenced by deletePlugin(), installPlugin(), showDeleteForm(), and showUpgradeForm().

PluginManagementHandler.installPlugin	(	$	path,
		&$	templateMgr
	)

Installs the uploaded plugin

Parameters:

	$path	string path to plugin Directory
	$templateMgr	reference to template manager

Returns:

boolean

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

References checkIfNewer(), getPluginCategory(), and setConnectionParams().

Referenced by managePlugins(), and uploadPlugin().

PluginManagementHandler.managePlugins

(

$

args

)

Display a list of plugins along with management options.

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

References deletePlugin(), installPlugin(), Request.redirect(), ManagerHandler.setupTemplate(), showDeleteForm(), showInstallForm(), showUpgradeForm(), upgradePlugin(), and uploadPlugin().

Referenced by deletePlugin(), showDeleteForm(), showInstallForm(), showUpgradeForm(), and uploadPlugin().

PluginManagementHandler.PluginManagementHandler

(

)

Constructor

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

PluginManagementHandler.setBreadcrumbs	(	$	subclass = false,
		$	category = null
	)

Set the page's breadcrumbs

Parameters:

	$subclass	boolean
	$category	string

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

References Request.url().

Referenced by deletePlugin(), showDeleteForm(), showInstallForm(), showUpgradeForm(), and uploadPlugin().

PluginManagementHandler.setConnectionParams

(

)

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

Returns:

array

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

Referenced by installPlugin(), and upgradePlugin().

PluginManagementHandler.showDeleteForm

(

$

plugin

)

Confirm deletion of plugin.

Parameters:

plugin

string

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

References getPluginCategory(), managePlugins(), setBreadcrumbs(), and ManagerHandler.setupTemplate().

Referenced by managePlugins().

PluginManagementHandler.showInstallForm

(

)

Show plugin installation form.

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

References managePlugins(), setBreadcrumbs(), and ManagerHandler.setupTemplate().

Referenced by managePlugins().

PluginManagementHandler.showUpgradeForm

(

$

plugin

)

Show form to select plugin for upgrade.

Parameters:

plugin

string

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

References getPluginCategory(), managePlugins(), setBreadcrumbs(), and ManagerHandler.setupTemplate().

Referenced by managePlugins().

PluginManagementHandler.upgradePlugin	(	$	path,
		&$	templateMgr
	)

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

Parameters:

	$path	string path to plugin Directory
	$templateMgr	reference to template manager

Returns:

boolean

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

References checkIfNewer(), and setConnectionParams().

Referenced by managePlugins(), and uploadPlugin().

PluginManagementHandler.uploadPlugin

(

$

function

)

Decompress uploaded plugin and install in the correct plugin directory. $param function string type of operation to perform after upload ('upgrade' or 'install')

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

References installPlugin(), managePlugins(), setBreadcrumbs(), ManagerHandler.setupTemplate(), and upgradePlugin().

Referenced by managePlugins().

---

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

• pages/manager/PluginManagementHandler.inc.php

---