Class ElggPluginManifestParser

Parent class for manifest parsers.

Converts manifest.xml files or strings to an array.

This should be extended by a class that does the actual work to convert based on the manifest.xml version.

This class only parses XML to an XmlEntity object and an array. The array should be used primarily to extract information since it is quicker to parse once and store values from the XmlElement object than to parse the object each time.

The array should be an exact representation of the manifest.xml file or string. Any normalization needs to be done in the calling class / function.

Direct known subclasses

ElggPluginManifestParser17, ElggPluginManifestParser18

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

Methods summary
`public`	# `__construct( ElggXMLElement $xml, object $caller )` Loads the manifest XML to be parsed. Loads the manifest XML to be parsed. Parameters `$xml` `ElggXmlElement` $xml The Manifest XML object to be parsed `$caller` `object` $caller The object calling this parser.
`public XmlElement`	# `getManifestObject( )` Returns the manifest XML object Returns the manifest XML object Returns `XmlElement`
`public array`	# `getManifest( )` Return the parsed manifest array Return the parsed manifest array Returns `array`
`public mixed`	# `getAttribute( string $name )` Return an attribute in the manifest. Return an attribute in the manifest. Parameters `$name` `string` $name Attribute name Returns `mixed`
`abstract public boolean`	# `parse( )` Parse the XML object into an array Parse the XML object into an array Returns `boolean`

Properties summary
`protected XmlElement`	`$manifestObject`	# The XmlElement object The XmlElement object
`protected array`	`$manifest`	# The manifest array The manifest array
`protected array`	`$validAttributes`	# All valid manifest attributes with default values. All valid manifest attributes with default values.
`protected object`	`$caller`	# The object we're doing parsing for. The object we're doing parsing for.

Packages

Classes

Class ElggPluginManifestParser

Direct known subclasses

Parameters

Returns

Returns

Parameters

Returns

Returns