Class ElggPluginManifest

Parses Elgg manifest.xml files.

Normalizes the values from the ElggManifestParser object.

This requires an ElggPluginManifestParser class implementation as $this->parser.

To add new parser versions, name them ElggPluginManifestParserXX where XX is the version specified in the top-level <plugin_manifest> tag's XML namespace.

Package: Elgg\Core\Plugins
Since: 1.8
Located at ElggPluginManifest.php

Methods summary
`public`	# `__construct( mixed $manifest, string $plugin_id = null )` Load a manifest file, XmlElement or path to manifest.xml file Load a manifest file, XmlElement or path to manifest.xml file Parameters `$manifest` `mixed` $manifest A string, XmlElement, or path of a manifest file. `$plugin_id` `string` $plugin_id Optional ID of the owning plugin. Used to fill in some values automatically.
`public integer`	# `getApiVersion( )` Returns the API version in use. Returns the API version in use. Returns `integer`
`public string`	# `getPluginID( )` Returns the plugin ID. Returns the plugin ID. Returns `string`
`public array`	# `getManifest( )` Returns the manifest array. Returns the manifest array. Used for backward compatibility. Specific methods should be called instead. Returns `array`
`public string`	# `getName( )` Returns the plugin name Returns the plugin name Returns `string`
`public string`	# `getDescription( )` Return the description Return the description Returns `string`
`public string`	# `getBlurb( )` Return the short description Return the short description Returns `string`
`public string`	# `getLicense( )` Returns the license Returns the license Returns `string`
`public string`	# `getRepositoryURL( )` Returns the repository url Returns the repository url Returns `string`
`public string`	# `getBugTrackerURL( )` Returns the bug tracker page Returns the bug tracker page Returns `string`
`public string`	# `getDonationsPageURL( )` Returns the donations page Returns the donations page Returns `string`
`public float`	# `getVersion( )` Returns the version of the plugin. Returns the version of the plugin. Returns `float`
`public string`	# `getAuthor( )` Returns the plugin author. Returns the plugin author. Returns `string`
`public string`	# `getCopyright( )` Return the copyright Return the copyright Returns `string`
`public string`	# `getWebsite( )` Return the website Return the website Returns `string`
`public array`	# `getCategories( )` Return the categories listed for this plugin Return the categories listed for this plugin Returns `array`
`public array`	# `getScreenshots( )` Return the screenshots listed. Return the screenshots listed. Returns `array`
`public array`	# `getProvides( )` Return the list of provides by this plugin. Return the list of provides by this plugin. Returns `array`
`public array`	# `getRequires( )` Returns the dependencies listed. Returns the dependencies listed. Returns `array`
`public array`	# `getSuggests( )` Returns the suggests elements. Returns the suggests elements. Returns `array`
`public array`	# `getConflicts( )` Returns the conflicts listed Returns the conflicts listed Returns `array`
`public boolean`	# `getActivateOnInstall( )` Should this plugin be activated when Elgg is installed Should this plugin be activated when Elgg is installed Returns `boolean`
`protected array`	# `buildStruct( array $struct, array $array )` Normalizes an array into the structure specified Normalizes an array into the structure specified Parameters `$struct` `array` $struct The struct to normalize $element to. `$array` `array` $array The array Returns `array`
`public static str`	# `getFriendlyCategory( str $category )` Returns a category's friendly name. This can be localized by defining the string 'admin:plugins:category:<category>'. If no localization is found, returns the category with _ and - converted to ' ' and then ucwords()'d. Returns a category's friendly name. This can be localized by defining the string 'admin:plugins:category:<category>'. If no localization is found, returns the category with _ and - converted to ' ' and then ucwords()'d. Parameters `$category` `str` $category The category as defined in the manifest. Returns `str` A human-readable category

Properties summary
`protected mixed`	`$parser`		# The parser object The parser object
`protected string`	`$namespace_root`	`'http://www.elgg.org/plugin_manifest/'`	# The root for plugin manifest namespaces. This is in the format http://www.elgg.org/plugin_manifest/<version> The root for plugin manifest namespaces. This is in the format http://www.elgg.org/plugin_manifest/<version>
`protected integer`	`$apiVersion`		# The API version of the manifest. The API version of the manifest.
`protected string`	`$pluginID`		# The optional plugin id this manifest belongs to. The optional plugin id this manifest belongs to.

Packages

Classes

Class ElggPluginManifest

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns