PluginAdministration Class Reference

Public Member Functions
	installPlugin ($filename)
	installPluginFromURL ($plugin_url)
	installPluginByName ($pluginname)
	uninstallPlugin ($plugin)
	getPluginTypes ()
	getUpdateInfo ($plugins)
	getMigrationInfo ()
	migratePlugin ($plugin_id)
	scanPluginDirectory ()
	registerPlugin ($plugindir)

Detailed Description

Model code for plugin administration tasks.

Member Function Documentation

getMigrationInfo()

getMigrationInfo

(

)

Fetch migration information plugins. This method returns for each plugin: current schema version and top migration version, if available.

Returns

array

getPluginTypes()

getPluginTypes

(

)

Get a list of the types of all installed plugins.

Returns

array list of plugin types

getUpdateInfo()

getUpdateInfo

(

$plugins

)

Fetch update information for a list of plugins. This method returns for each plugin: the plugin name, current version and meta data of the plugin update, if available.

Parameters

array

$plugins

array of plugin meta data

installPlugin()

installPlugin

(

$filename

)

Install a new plugin. Extracts the contents of the uploaded file, checks the manifest, creates the new plugin directory und finally registers the plugin in the database.

Parameters

string

$filename

path to the uploaded file

installPluginByName()

installPluginByName

(

$pluginname

)

Download and install a plugin with the given name from the plugin repository.

Parameters

string

$pluginname

name of the plugin to install

installPluginFromURL()

installPluginFromURL

(

$plugin_url

)

Download and install a new plugin from the given URL.

Parameters

string

$plugin_url

the URL of the plugin package

migratePlugin()

migratePlugin

(

$plugin_id

)

migrate plugin to top migration

Parameters

integer

$plugin_id

Returns

string output from migrator

registerPlugin()

registerPlugin

(

$plugindir

)

registers plugin at given path in database

Parameters

string

$plugindir

path to plugin

Exceptions

PluginInstallationException

scanPluginDirectory()

scanPluginDirectory

(

)

scans PLUGINS_PATH for plugin.manifest files belonging to not registered plugins

Returns

array with manifest meta data

uninstallPlugin()

uninstallPlugin

(

$plugin

)

Uninstall the given plugin from the system. It will remove the database schema and all the plugin's files.

Parameters

array

$plugin

meta data of plugin

---

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

• lib/classes/PluginAdministration.php