t3lib_loadModules Class Reference

List of all members.

Public Member Functions
	load ($modulesArray, $BE_USER='')
	checkExtensionModule ($name)
	checkMod ($name, $fullpath)
	checkModAccess ($name, $MCONF)
	checkModWorkspace ($name, $MCONF)
	parseModulesArray ($arr)
	cleanName ($str)
	getRelativePath ($baseDir, $destDir)
Public Attributes
	$modules = Array()
	$absPathArray = array()
	$modListGroup = Array()
	$modListUser = Array()
	$BE_USER = ''
	$observeWorkspaces = FALSE

---

Detailed Description

Definition at line 79 of file class.t3lib_loadmodules.php.

---

Member Function Documentation

t3lib_loadModules::checkExtensionModule

(

$

name

)

If the module name ($name) is a module from an extension (has path in $this->absPathArray) then that path is returned relative to PATH_site

Parameters:

string

Module name

Returns:

string If found, the relative path from PATH_site

Definition at line 367 of file class.t3lib_loadmodules.php.

Referenced by load().

t3lib_loadModules::checkMod	(	$	name,
		$	fullpath
	)

Here we check for the module. Return values: 'notFound': If the module was not found in the path (no "conf.php" file) false: If no access to the module (access check failed) array(): Configuration array, in case a valid module where access IS granted exists.

Parameters:

	string	Module name
	string	Absolute path to module

Returns:

mixed See description of function

Definition at line 386 of file class.t3lib_loadmodules.php.

References $GLOBALS, $MCONF, $MLANG, checkModAccess(), checkModWorkspace(), getRelativePath(), and t3lib_div::resolveBackPath().

Referenced by load().

t3lib_loadModules::checkModAccess	(	$	name,
		$	MCONF
	)

Returns true if the internal BE_USER has access to the module $name with $MCONF (based on security level set for that module)

Parameters:

	string	Module name
	array	MCONF array (module configuration array) from the modules conf.php file (contains settings about what access level the module has)

Returns:

boolean True if access is granted for $this->BE_USER

Definition at line 470 of file class.t3lib_loadmodules.php.

References $MCONF.

Referenced by checkMod().

t3lib_loadModules::checkModWorkspace	(	$	name,
		$	MCONF
	)

Check if a module is allowed inside the current workspace for be user Processing happens only if $this->observeWorkspaces is TRUE

Parameters:

	string	Module name
	array	MCONF array (module configuration array) from the modules conf.php file (contains settings about workspace restrictions)

Returns:

boolean True if access is granted for $this->BE_USER

Definition at line 494 of file class.t3lib_loadmodules.php.

References $MCONF, and t3lib_div::inList().

Referenced by checkMod().

t3lib_loadModules::cleanName

(

$

str

)

The $str is cleaned so that it contains alphanumerical characters only. Modules must only consist of these characters

Parameters:

string

String to clean up

Returns:

string

Definition at line 547 of file class.t3lib_loadmodules.php.

Referenced by parseModulesArray().

t3lib_loadModules::getRelativePath	(	$	baseDir,
		$	destDir
	)

Get relative path for $destDir compared to $baseDir

Parameters:

	string	Base directory
	string	Destination directory

Returns:

string The relative path of destination compared to base.

Definition at line 558 of file class.t3lib_loadmodules.php.

Referenced by checkMod().

t3lib_loadModules::load	(	$	modulesArray,
		$	BE_USER = ''
	)

Init. The outcome of the load() function will be a $this->modules array populated with the backend module structure available to the BE_USER Further the global var $LANG will have labels and images for the modules loaded in an internal array.

Parameters:

	array	$modulesArray should be the global var $TBE_MODULES, $BE_USER can optionally be set to an alternative Backend user object than the global var $BE_USER (which is the currently logged in user)
	object	Optional backend user object to use. If not set, the global BE_USER object is used.

Returns:

void

Definition at line 104 of file class.t3lib_loadmodules.php.

References $BE_USER, $GLOBALS, checkExtensionModule(), checkMod(), and parseModulesArray().

t3lib_loadModules::parseModulesArray

(

$

arr

)

Parses the moduleArray ($TBE_MODULES) into a internally useful structure. Returns an array where the keys are names of the module and the values may be true (only module) or an array (of submodules)

Parameters:

array

moduleArray ($TBE_MODULES)

Returns:

array Output structure with available modules

Definition at line 518 of file class.t3lib_loadmodules.php.

References cleanName(), and t3lib_div::trimExplode().

Referenced by load().

---

Member Data Documentation

t3lib_loadModules::$absPathArray = array()

Definition at line 81 of file class.t3lib_loadmodules.php.

t3lib_loadModules::$BE_USER = ''

Definition at line 91 of file class.t3lib_loadmodules.php.

Referenced by load().

t3lib_loadModules::$modListGroup = Array()

Definition at line 83 of file class.t3lib_loadmodules.php.

t3lib_loadModules::$modListUser = Array()

Definition at line 84 of file class.t3lib_loadmodules.php.

t3lib_loadModules::$modules = Array()

Definition at line 80 of file class.t3lib_loadmodules.php.

t3lib_loadModules::$observeWorkspaces = FALSE

Definition at line 92 of file class.t3lib_loadmodules.php.

---

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

• t3lib/class.t3lib_loadmodules.php

---