PluginHelper Class Reference

Public Member Functions
	extractPlugin ($filePath, $originalFileName)
	installPlugin ($path)
	upgradePlugin ($category, $plugin, $path)

Protected Member Functions
	_checkIfNewer ($productType, $productName, $newVersion)
	_getConnectionParams ()

Detailed Description

Helper class implementing plugin administration functions.

Definition at line 29 of file PluginHelper.inc.php.

Member Function Documentation

_checkIfNewer()

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

protected

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

Parameters

$productType	string Product type of plugin
$productName	string Product name of plugin
$newVersion	Version Version object of plugin to check against database

Returns

boolean

Definition at line 146 of file PluginHelper.inc.php.

References DAORegistry\getDAO().

Referenced by installPlugin(), and upgradePlugin().

_getConnectionParams()

PluginHelper::_getConnectionParams ( )

protected

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

Returns

array

Definition at line 157 of file PluginHelper.inc.php.

References Config\getVar().

Referenced by installPlugin(), and upgradePlugin().

extractPlugin()

PluginHelper::extractPlugin	(		$filePath,
			$originalFileName
	)

Extract and validate a plugin (prior to installation)

Parameters

$filePath	string Full path to plugin archive
$originalFileName	string Original filename of plugin archive

Returns

string Extracted plugin path

Definition at line 36 of file PluginHelper.inc.php.

References Config\getVar(), and PKPString\regexp_match_get().

installPlugin()

PluginHelper::installPlugin

(

$path

)

Installs an extracted plugin

Parameters

$path

string path to plugin Directory

Returns

Version Version of installed plugin on success

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

References _checkIfNewer(), _getConnectionParams(), Core\getBaseDir(), DAORegistry\getDAO(), and VersionCheck\getValidPluginVersionInfo().

upgradePlugin()

PluginHelper::upgradePlugin	(		$category,
			$plugin,
			$path
	)

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

Parameters

$category	string
$plugin	string
$path	string path to plugin Directory

Returns

Version

Definition at line 176 of file PluginHelper.inc.php.

References _checkIfNewer(), _getConnectionParams(), Core\getBaseDir(), DAORegistry\getDAO(), and VersionCheck\getValidPluginVersionInfo().

---

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

• PluginHelper.inc.php