PluginAdministration Class Reference

Collaboration diagram for PluginAdministration:

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

Detailed Description

Model code for plugin administration tasks.

Member Function Documentation

getInstitutes()

getInstitutes

(

)

Get a list of all available institutes.

Here is the call graph for this function:

getMigrationInfo()

getMigrationInfo

(

)

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

Returns

array

Here is the call graph for this function:

getPluginManifest()

getPluginManifest

(

$plugindir

)

Read the manifest of the plugin in the given directory. Returns NULL if the manifest cannot be found.

Returns

array containing the manifest information

Here is the call graph for this function:

getPluginTypes()

getPluginTypes

(

)

Get a list of the types of all installed plugins.

Returns

array list of plugin types

Here is the call graph for this function:

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

Here is the call graph for this function:

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

Here is the call graph for this function:

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

Here is the call graph for this function:

migratePlugin()

migratePlugin

(

$plugin_id

)

migrate plugin to top migration

Parameters

integer

$plugin_id

Returns

string output from migrator

Here is the call graph for this function:

registerPlugin()

registerPlugin

(

$plugindir

)

registers plugin at given path in database

Parameters

string

$plugindir

path to plugin

Exceptions

PluginInstallationException

Here is the call graph for this function:

scanPluginDirectory()

scanPluginDirectory

(

)

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

Returns

array with manifest meta data

Here is the call graph for this function:

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

Here is the call graph for this function:

---

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

• app/models/plugin_administration.php