PluginEngine Class Reference

Collaboration diagram for PluginEngine:

Static Public Member Functions
static	getCurrentPluginId ()
static	routeRequest ($dispatch_to)
static	loadPlugins ()
static	getPlugin ($class)
static	getPlugins ($type, $context=NULL)
static	sendMessage ($type, $method)
static	sendMessageWithContext ($type, $context, $method)
static	getURL ($plugin, $params=array(), $cmd='show', $ignore_registered_params=false)
static	getLink ($plugin, $params=array(), $cmd='show', $ignore_registered_params=false)
static	getLinkToAdministrationPlugin ($params=array(), $cmd='show')
static	saveToSession ($plugin, $key, $value)
static	getValueFromSession ($plugin, $key)

Member Function Documentation

getCurrentPluginId()

static getCurrentPluginId ( )

static

Deprecated:

Returns

int returns the current plugin's ID

Here is the call graph for this function:

Here is the caller graph for this function:

getLink()

static getLink (   $plugin,   $params = array(),   $cmd = 'show',   $ignore_registered_params = false  )

static

Generates a link (entity encoded URL) which can be shown in user interfaces

Parameters

	$plugin	- the plugin to which should be linked
	$params	- an array with name value pairs
	$cmd	- command to execute by clicking the link
bool	$ignore_registered_params	do not add registeredparams

Returns

a link to the current plugin with the additional $params

Here is the call graph for this function:

Here is the caller graph for this function:

getLinkToAdministrationPlugin()

static getLinkToAdministrationPlugin (   $params = array(),   $cmd = 'show'  )

static

Generates a link to the plugin administration which can be shown in user interfaces

Deprecated:

Parameters

array	an optional array with name value pairs
string	an optional command defaulting to 'show'

Returns

string a link to the administration plugin with the additional $params

Here is the call graph for this function:

getPlugin()

static getPlugin (   $class )

static

Get instance of the plugin specified by plugin class name.

Parameters

$class

class name of plugin

Here is the call graph for this function:

Here is the caller graph for this function:

getPlugins()

static getPlugins (   $type,   $context = NULL  )

static

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:

Here is the caller graph for this function:

getURL()

static getURL (   $plugin,   $params = array(),   $cmd = 'show',   $ignore_registered_params = false  )

static

Generates a URL which can be shown in user interfaces

Parameters

	$plugin	- the plugin to which should be linked
	$params	- an array with name value pairs
	$cmd	- command to execute by clicking the link
bool	$ignore_registered_params	do not add registered params

Returns

a link to the current plugin with the additional $params

Here is the call graph for this function:

Here is the caller graph for this function:

getValueFromSession()

static getValueFromSession (   $plugin,   $key  )

static

Retrieves the value to key from the global plugin session

Deprecated:

loadPlugins()

static loadPlugins ( )

static

Load the default set of plugins. This currently loads plugins of type Homepage, Standard (if a course is selected), Administration (if user has admin status) and System. The exact type of plugins loaded here may change in the future.

Here is the call graph for this function:

Here is the caller graph for this function:

routeRequest()

static routeRequest (   $dispatch_to )

static

This function maps an incoming request to a tuple (pluginclassname, unconsumed rest).

Returns

array the above mentioned tuple

Here is the caller graph for this function:

saveToSession()

static saveToSession (   $plugin,   $key,   $value  )

static

Saves a value to the global session

Deprecated:

Parameters

StudIPPlugin	$plugin	- the plugin for which the value should be saved
string	$key	- a key for the value. has to be unique for the calling plugin
string	$value	- the value, which should be saved into the session

sendMessage()

static sendMessage (   $type,   $method  )

static

Sends a message to all activated plugins of a type and returns an array of the return values.

Parameters

type	plugin type or NULL (all types)
string	the method name that should be send to all plugins
mixed	a variable number of arguments

Returns

array an array containing the return values

sendMessageWithContext()

static sendMessageWithContext (   $type,   $context,   $method  )

static

Sends a message to all activated plugins of a type enabled in a context and returns an array of the return values.

Parameters

type	plugin type or NULL (all types)
context	context range id (may be NULL)
string	the method name that should be send to all plugins
mixed	a variable number of arguments

Returns

array an array containing the return values

---

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

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