PluginRepository Class Reference

Collaboration diagram for PluginRepository:

Public Member Functions
	__construct ($url=NULL)
	readMetadata ($url)
	getPlugin ($name)
	getPlugins ($search=NULL)

Protected Member Functions
	registerPlugin ($name, $meta_data)

Detailed Description

Class used to locate plugins available from a plugin repository.

Constructor & Destructor Documentation

__construct

(

$url = NULL

)

Initialize a new PluginRepository and read meta data from the given URL or the default list of URLs (if $url is NULL).

Here is the call graph for this function:

Member Function Documentation

getPlugin

(

$name

)

Get meta data for the plugin with the given name (if available). Always chooses the newest compatible version of the plugin.

Returns

array meta data for plugin (or NULL)

getPlugins

(

$search = NULL

)

Get meta data for all plugins whose names contain the given string. You may omit the search string to get a list of all available plugins. Returns the newest compatible version of each plugin.

Returns

array array of meta data for matching plugins

readMetadata

(

$url

)

Read plugin meta data from the given URL (using XML format). The structure of the XML is:

<plugins> <plugin name="DummyPlugin" <release version="2.0" url="http://plugins.example.com/dummy-2.0.zip" studipminversion="1.4" studipmaxversion="1.9"> </plugin> [...] </plugins>

Here is the call graph for this function:

Here is the caller graph for this function:

registerPlugin (   $name,   $meta_data  )

protected

Register a new plugin in this repository.

Parameters

$name	string plugin name
$meta_data	array of plugin meta data

Here is the caller graph for this function:

---

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

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