ModuleInfoXml Class Reference

Inheritance diagram for ModuleInfoXml:

[legend]Collaboration diagram for ModuleInfoXml:

[legend]List of all members.

Public Member Functions
	ModuleInfoXml ($name)
	_ProcessXml ()
	_ProcessXmlChildren ($tree)
	_ProcessXmlPermissions ($tree)
	_ProcessXmlConfig ($tree)
	getName ()
	getVersion ()
	getScreenNames ()
	getPermissions ()
	getConfig ()
	getImplements ()
	Implements ($string)
	getRequires ()
	Requires ($string)
	getSql ()
Public Attributes
	$filename
	The XML file name.
	$parser
	The XML parser.
	$name
	The name of the module.
	$version
	The version of the module.
	$screenname
	The screen name of the module.
	$permissions
	An object with the permissions of the module.
	$config
	An object with the config info the module.
	$what_implements
	Array with the interfaces that the module implements.
	$what_requires
	Array with the interfaces that the module requires.
	$sql
	An SQL query to create the tables.

---

Detailed Description

Class designed to deal with the XML configuration file of the modules. It just reads a given XML file and gives an easy access to its contents It is a read-only class because the file shouldn't be modified by the system

Definition at line 24 of file ModuleInfoXml.class.php.

---

Constructor & Destructor Documentation

ModuleInfoXml::ModuleInfoXml (  $  name  )

Receives the name of the XML, parses it and extracts the concrete information Parameters: name  The name of the XML file. Definition at line 44 of file ModuleInfoXml.class.php. References $name, and JSystem::IsError().

---

Member Function Documentation

ModuleInfoXml::_ProcessXml (   )

Parses the XML file using the xml expat in PHP Returns: JError if there was an error Definition at line 60 of file ModuleInfoXml.class.php. References ERROR_NO_NAME.

ModuleInfoXml::_ProcessXmlChildren (  $  tree  )

Process the children of the xml tree. Parameters: tree  An xml tree Definition at line 78 of file ModuleInfoXml.class.php.

ModuleInfoXml::_ProcessXmlConfig (  $  tree  )

Process the config information given its tree. Parameters: tree  An array with the config information tree. Definition at line 134 of file ModuleInfoXml.class.php.

ModuleInfoXml::_ProcessXmlPermissions (  $  tree  )

Process the permissions given the permissions tree. Parameters: tree  An array with the permissions tree. Definition at line 118 of file ModuleInfoXml.class.php.

ModuleInfoXml::getConfig (   )

Gets the array with all confi information of the module Returns: Array of ModuleInfoXmlConfig indexed by name Reimplemented from IModuleInfo. Definition at line 187 of file ModuleInfoXml.class.php.

ModuleInfoXml::getImplements (   )

Gets the array with the interfaces that implements the module Returns: Array of string Reimplemented from IModuleInfo. Definition at line 196 of file ModuleInfoXml.class.php.

ModuleInfoXml::getName (   )

Gets the name of the module Returns: string Reimplemented from IModuleInfo. Definition at line 150 of file ModuleInfoXml.class.php.

ModuleInfoXml::getPermissions (   )

Gets the array with all permissions of the module Returns: Array of ModuleInfoXmlPermission indexed by name Reimplemented from IModuleInfo. Definition at line 178 of file ModuleInfoXml.class.php.

ModuleInfoXml::getRequires (   )

Gets the array with the interfaces that requires the module Returns: Array of string Reimplemented from IModuleInfo. Definition at line 215 of file ModuleInfoXml.class.php.

ModuleInfoXml::getScreenNames (   )

Gets the array with all the screen names of the module (in several languages) Returns: Array like sn["en"] = "Screen name in English" Reimplemented from IModuleInfo. Definition at line 169 of file ModuleInfoXml.class.php.

ModuleInfoXml::getSql (   )

Gets the array with the sql queries needed by the module Returns: Array of string Reimplemented from IModuleInfo. Definition at line 234 of file ModuleInfoXml.class.php.

ModuleInfoXml::getVersion (   )

Gets the version of the module Returns: string Reimplemented from IModuleInfo. Definition at line 159 of file ModuleInfoXml.class.php.

ModuleInfoXml::Implements (  $  string  )

Checks if the module implements a concrete interface Parameters: string  The name of the interface Returns: boolean Reimplemented from IModuleInfo. Definition at line 206 of file ModuleInfoXml.class.php.

ModuleInfoXml::Requires (  $  string  )

Checks if the module requires a concrete interface Parameters: string  The name of the interface Returns: boolean Reimplemented from IModuleInfo. Definition at line 225 of file ModuleInfoXml.class.php.

---

Member Data Documentation

ModuleInfoXml::$config

An object with the config info the module. Definition at line 34 of file ModuleInfoXml.class.php.

ModuleInfoXml::$filename

The XML file name. Definition at line 26 of file ModuleInfoXml.class.php.

ModuleInfoXml::$name

The name of the module. Definition at line 30 of file ModuleInfoXml.class.php. Referenced by ModuleInfoXml().

ModuleInfoXml::$parser

The XML parser. Definition at line 28 of file ModuleInfoXml.class.php.

ModuleInfoXml::$permissions

An object with the permissions of the module. Definition at line 33 of file ModuleInfoXml.class.php.

ModuleInfoXml::$screenname

The screen name of the module. Definition at line 32 of file ModuleInfoXml.class.php.

ModuleInfoXml::$sql

An SQL query to create the tables. Definition at line 37 of file ModuleInfoXml.class.php.

ModuleInfoXml::$version

The version of the module. Definition at line 31 of file ModuleInfoXml.class.php.

ModuleInfoXml::$what_implements

Array with the interfaces that the module implements. Definition at line 35 of file ModuleInfoXml.class.php.

ModuleInfoXml::$what_requires

Array with the interfaces that the module requires. Definition at line 36 of file ModuleInfoXml.class.php.

---

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

• ModuleInfoXml.class.php

---