Module Class Reference

Inheritance diagram for Module:

[legend]Collaboration diagram for Module:

[legend]List of all members.

Public Member Functions
	Module ($idM)
	GetRelativePath ()
	_GetInfoFilePath ()
&	_GetPermissions ()
	GetId ()
	GetName ()
&	GetInformation ()
	GetPermissionId ($name)
	GetConfig ($key)
	SetConfig ($keys, $user=true, $group=false)
	GetAllModulesId ()
Public Attributes
	$data
	An array with all DB fields about a concrete module.
	$modinfo
	An IModuleInfo object with information about the module.
	$idPerms
	Array with the permissions of the module and their idPs.

---

Detailed Description

Class that abstracts the access to Modules information

Definition at line 13 of file Module.class.php.

---

Constructor & Destructor Documentation

Module::Module (  $  idM  )

Class constructor. It creates a Module object given its id. Parameters: idM  The id of the module. Definition at line 27 of file Module.class.php.

---

Member Function Documentation

Module::_GetInfoFilePath (   )

Gets the path where the module.xml file is Returns: string Definition at line 63 of file Module.class.php. References JSystem::GetConfig().

& Module::_GetPermissions (   )

Gets all permissions for this module. Returns: Array of idP indexed by the name of the permission. Definition at line 79 of file Module.class.php.

Module::GetAllModulesId (   )

Gets a DBJames with all id of the modules installed in the system. Returns: DBJames Definition at line 183 of file Module.class.php. Referenced by Modules::_RefreshModules().

Module::GetConfig (  $  key  )

Gets the config value. Parameters: key  The name of the config key. Returns: value Definition at line 157 of file Module.class.php. References JConfig::GetInstance().

Module::GetId (   )

Gets the id of the module Returns: idM Definition at line 105 of file Module.class.php.

& Module::GetInformation (   )

Gets all the information about the module. It reads the module.xml file and returns the information Returns: IModuleInfo Definition at line 125 of file Module.class.php. References ModuleInfo::GetInformation().

Module::GetName (   )

Gets the name of the module Returns: name Definition at line 114 of file Module.class.php.

Module::GetPermissionId (  $  name  )

Gets the id of a certain permission. Parameters: name  The name of the permission Returns: idP Definition at line 145 of file Module.class.php.

Module::GetRelativePath (   )

Gets the relative path where this module is installed Returns: string Definition at line 51 of file Module.class.php.

Module::SetConfig (  $  keys, $  user = true, $  group = false )

Sets a config value. Parameters: keys  An array with key, value pairs. user  boolean indicating whether the config value will be stored in the user config or not. group  boolean idem with group. Definition at line 172 of file Module.class.php. References JConfig::GetInstance().

---

Member Data Documentation

Module::$data

An array with all DB fields about a concrete module. Definition at line 16 of file Module.class.php.

Module::$idPerms

Array with the permissions of the module and their idPs. Definition at line 18 of file Module.class.php.

Module::$modinfo

An IModuleInfo object with information about the module. Definition at line 17 of file Module.class.php.

---

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

• Module.class.php

---