PluginManager Class Reference

Collaboration diagram for PluginManager:

Public Member Functions
	setPluginEnabled ($id, $enabled, $force=false)
	setPluginPosition ($id, $position)
	isPluginActivated ($id, $context)
	isPluginActivatedForUser ($pluginId, $userId)
	setPluginActivated ($id, $rangeId, $active, $context='sem')
	getDefaultActivations ($id)
	setDefaultActivations ($id, $institutes)
	setPluginsDisabled ($status)
	isPluginsDisabled ()
	registerPlugin ($name, $class, $path, $depends=NULL)
	unregisterPlugin ($id)
	getPluginInfo ($class)
	getPluginInfoById ($id)
	getPluginInfos ($type=NULL)
	getPlugin ($class)
	getPluginById ($id)
	getPlugins ($type, $context=NULL)
	getPluginManifest ($plugindir)

Static Public Member Functions
static	getInstance ()

Protected Member Functions
	checkUserAccess ($plugin, $user)
	getCachedPlugin ($plugin_info)

Member Function Documentation

checkUserAccess()

checkUserAccess (   $plugin,   $user  )

protected

Check user access permission for the given plugin.

Parameters

$plugin	plugin meta data
$user	user id of user

Here is the caller graph for this function:

getCachedPlugin()

getCachedPlugin (   $plugin_info )

protected

Get instance of the plugin specified by plugin meta data.

Parameters

$plugin_info

plugin meta data

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultActivations()

getDefaultActivations

(

$id

)

Returns the list of institutes for which a specific plugin is enabled by default.

Parameters

$id	id of the plugin

Here is the call graph for this function:

getInstance()

static getInstance ( )

static

Returns the PluginManager singleton instance.

Here is the call graph for this function:

Here is the caller graph for this function:

getPlugin()

getPlugin

(

$class

)

Get instance of the plugin specified by plugin class name.

Parameters

$class

class name of plugin

Here is the call graph for this function:

getPluginById()

getPluginById

(

$id

)

Get instance of the plugin specified by plugin id.

Parameters

$id	id of the plugin

Here is the call graph for this function:

getPluginInfo()

getPluginInfo

(

$class

)

Get meta data for the plugin specified by plugin class name.

Parameters

$class

class name of plugin

Here is the caller graph for this function:

getPluginInfoById()

getPluginInfoById

(

$id

)

Get meta data for the plugin specified by plugin id.

Parameters

$id	id of the plugin

Here is the caller graph for this function:

getPluginInfos()

getPluginInfos

(

$type = NULL

)

Get meta data for all plugins of the specified type. A type of NULL returns meta data for all installed plugins.

Parameters

$type

plugin type or NULL (all types)

Here is the caller 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

getPlugins()

getPlugins	(		$type,
			$context = NULL
	)

Get instances of all plugins of the specified type. A type of NULL returns all enabled plugins. The optional context parameter can be used to get only plugins that are activated in the given context.

Parameters

$type	plugin type or NULL (all types)
$context	context range id (optional)

Here is the call graph for this function:

isPluginActivated()

isPluginActivated	(		$id,
			$context
	)

Get the activation status of a plugin in the given context. This also checks the plugin default activations and sem_class-settings.

Parameters

$id	id of the plugin
$context	context range id

Here is the call graph for this function:

Here is the caller graph for this function:

isPluginActivatedForUser()

isPluginActivatedForUser	(		$pluginId,
			$userId
	)

Get the activation status of a plugin for the given user. This also checks the plugin default activations and sem_class-settings.

Parameters

$pluginId	id of the plugin
$userId	id of the user

Here is the call graph for this function:

isPluginsDisabled()

isPluginsDisabled

(

)

Check whether loading of non-core plugins is currently disabled.

Here is the call graph for this function:

Here is the caller graph for this function:

registerPlugin()

registerPlugin	(		$name,
			$class,
			$path,
			$depends = NULL
	)

Register a new plugin or update an existing plugin entry in the data base. Returns the id of the new or updated plugin.

Parameters

$name	plugin name
$class	plugin class name
$path	plugin relative path
$depends	id of plugin this plugin depends on

Here is the call graph for this function:

setDefaultActivations()

setDefaultActivations	(		$id,
			$institutes
	)

Set the list of institutes for which a specific plugin should be enabled by default.

Parameters

$id	id of the plugin
$institutes	array of institute ids

Here is the call graph for this function:

setPluginActivated()

setPluginActivated	(		$id,
			$rangeId,
			$active,
			$context = 'sem'
	)

Sets the activation status of a plugin in the given context.

Parameters

$id	id of the plugin
$rangeId	context range id
$active	plugin status (true or false)
$context	context of plugin activation

Here is the call graph for this function:

setPluginEnabled()

setPluginEnabled	(		$id,
			$enabled,
			$force = false
	)

Set the enabled/disabled status of the given plugin.

If the plugin implements the method "onEnable" or "onDisable", this method will be called accordingly. If the method returns false or throws and exception, the plugin's activation state is not updated.

Parameters

string	$id	id of the plugin
bool	$enabled	plugin status (true or false)
bool	$force	force (de)activation regardless of the result of on(en|dis)able

Returns

bool indicating whether the plugin was updated or null if the passed state equals the current state or if the plugin is missing.

Here is the call graph for this function:

setPluginPosition()

setPluginPosition	(		$id,
			$position
	)

Set the navigation position of the given plugin.

Parameters

$id	id of the plugin
$position	plugin navigation position

Returns

bool indicating whether any change occured

Here is the call graph for this function:

setPluginsDisabled()

setPluginsDisabled

(

$status

)

Disable loading of all non-core plugins for the current session.

Parameters

$status

true: disable non-core plugins

unregisterPlugin()

unregisterPlugin

(

$id

)

Remove registration for the given plugin from the data base.

Parameters

$id	id of the plugin

Here is the call graph for this function:

---

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

• lib/plugins/engine/PluginManager.class.php