Inheritance diagram for t3lib_SCbase:

Public Member Functions
	init ()
	menuConfig ()
	mergeExternalItems ($modName, $menuKey, $menuArr)
	handleExternalFunctionValue ($MM_key= 'function', $MS_value=NULL)
	getExternalItemConfig ($modName, $menuKey, $value= '')
	checkExtObj ()
	checkSubExtObj ()
	extObjHeader ()
	extObjContent ()
Public Attributes
	$MCONF = array()
	$id
	$CMD
	$perms_clause
	$MOD_MENU
	$MOD_SETTINGS = array()
	$modTSconfig
	$modMenu_type = ''
	$modMenu_dontValidateList = ''
	$modMenu_setDefaultList = ''
	$extClassConf
	$include_once = array()
	$content = ''
	$doc
	$extObj

Detailed Description

Definition at line 119 of file class.t3lib_scbase.php.

Member Function Documentation

t3lib_SCbase::checkExtObj ( )

Creates an instance of the class found in $this->extClassConf['name'] in $this->extObj if any (this should hold three keys, "name", "path" and "title" if a "Function menu module" tries to connect...) This value in extClassConf might be set by an extension (in a ext_tables/ext_localconf file) which thus "connects" to a module. The array $this->extClassConf is set in handleExternalFunctionValue() based on the value of MOD_SETTINGS[function] (Should be) called from global scope right after inclusion of files from the ->include_once array. If an instance is created it is initiated with $this passed as value and $this->extClassConf as second argument. Further the $this->MOD_SETTING is cleaned up again after calling the init function.

Returns:: void

See also:: handleExternalFunctionValue(), t3lib_extMgm::insertModuleFunction(), $extObj

Definition at line 335 of file class.t3lib_scbase.php.

References t3lib_div\_GP(), t3lib_BEfunc\getModuleData(), and t3lib_div\makeInstance().

t3lib_SCbase::checkSubExtObj ( )

Calls the checkExtObj function in sub module if present.

Returns:: void

Definition at line 356 of file class.t3lib_scbase.php.

t3lib_SCbase::extObjContent ( )

Calls the 'main' function inside the "Function menu module" if present

Returns:: void

Definition at line 381 of file class.t3lib_scbase.php.

Referenced by SC_mod_web_info_index\main(), SC_mod_web_ts_index\main(), SC_mod_web_func_index\main(), SC_mod_tools_em_index\main(), and SC_mod_tools_em_index\showExtDetails().

t3lib_SCbase::extObjHeader ( )

Calls the 'header' function inside the "Function menu module" if present. A header function might be needed to add JavaScript or other stuff in the head. This can't be done in the main function because the head is already written. example call in the header function: $this->pObj->doc->JScode = $this->pObj->doc->wrapScriptTags(' ...

Returns:: void

Definition at line 370 of file class.t3lib_scbase.php.

t3lib_SCbase::getExternalItemConfig	(	$	modName,
		$	menuKey,
		$	value = `''`
	)

Returns configuration values from the global variable $TBE_MODULES_EXT for the module given. For example if the module is named "web_info" and the "function" key ($menuKey) of MOD_SETTINGS is "stat" ($value) then you will have the values of $TBE_MODULES_EXT['webinfo']['MOD_MENU']['function']['stat'] returned.

Parameters:

string	Module name
string	Menu key, eg. "function" for the function menu. See $this->MOD_MENU
string	Optionally the value-key to fetch from the array that would otherwise have been returned if this value was not set. Look source...

Returns:: mixed The value from the TBE_MODULES_EXT array.

See also:: handleExternalFunctionValue()

Definition at line 321 of file class.t3lib_scbase.php.

References $GLOBALS, and $value.

Referenced by handleExternalFunctionValue(), and SC_mod_tools_em_index\handleExternalFunctionValue().

t3lib_SCbase::handleExternalFunctionValue	(	$	MM_key = `'function'`,
		$	MS_value = `NULL`
	)

Loads $this->extClassConf with the configuration for the CURRENT function of the menu. If for this array the key 'path' is set then that is expected to be an absolute path to a file which should be included - so it is set in the internal array $this->include_once

Parameters:

string	The key to MOD_MENU for which to fetch configuration. 'function' is default since it is first and foremost used to get information per "extension object" (I think that is what its called)
string	The value-key to fetch from the config array. If NULL (default) MOD_SETTINGS[$MM_key] will be used. This is usefull if you want to force another function than the one defined in MOD_SETTINGS[function]. Call this in init() function of your Script Class: handleExternalFunctionValue('function', $forcedSubModKey)

Returns:: void

See also:: getExternalItemConfig(), $include_once, init()

Reimplemented in SC_mod_tools_em_index.

Definition at line 303 of file class.t3lib_scbase.php.

References getExternalItemConfig().

Referenced by init().

t3lib_SCbase::init ( )

Initializes the backend module by setting internal variables, initializing the menu.

Returns:: void

See also:: menuConfig()

Reimplemented in SC_mod_user_ws_index, SC_mod_tools_em_index, SC_mod_user_ws_workspaceForms, tx_scheduler_Module, SC_mod_user_ws_publish, SC_mod_web_ts_index, and tx_tsconfighelp_module1.

Definition at line 230 of file class.t3lib_scbase.php.

References $GLOBALS, t3lib_div\_GP(), handleExternalFunctionValue(), and menuConfig().

Referenced by tx_reports_Module\__construct(), SC_mod_user_task_index\__construct(), and tx_recycler_module1\initialize().

t3lib_SCbase::menuConfig ( )

Initializes the internal MOD_MENU array setting and unsetting items based on various conditions. It also merges in external menu items from the global array TBE_MODULES_EXT (see mergeExternalItems()) Then MOD_SETTINGS array is cleaned up (see t3lib_BEfunc::getModuleData()) so it contains only valid values. It's also updated with any SET[] values submitted. Also loads the modTSconfig internal variable.

Returns:: void

See also:: init(), $MOD_MENU, $MOD_SETTINGS, t3lib_BEfunc::getModuleData(), mergeExternalItems()

Reimplemented in SC_mod_tools_em_index, tx_version_cm1, SC_mod_tools_log_index, SC_mod_user_ws_index, tx_scheduler_Module, SC_mod_user_task_index, tx_reports_Module, tx_tsconfighelp_module1, and tx_dbal_module1.

Definition at line 250 of file class.t3lib_scbase.php.

References t3lib_div\_GP(), t3lib_BEfunc\getModTSconfig(), t3lib_BEfunc\getModuleData(), mergeExternalItems(), and t3lib_BEfunc\unsetMenuItems().

Referenced by init().

t3lib_SCbase::mergeExternalItems	(	$	modName,
		$	menuKey,
		$	menuArr
	)

Merges menu items from global array $TBE_MODULES_EXT

Parameters:

string	Module name for which to find value
string	Menu key, eg. 'function' for the function menu.
array	The part of a MOD_MENU array to work on.

Returns:: array Modified array part. private

See also:: t3lib_extMgm::insertModuleFunction(), menuConfig()

Definition at line 279 of file class.t3lib_scbase.php.

References $GLOBALS, and t3lib_div\inList().

Referenced by menuConfig(), and SC_mod_tools_em_index\menuConfig().

Member Data Documentation

t3lib_SCbase::$CMD

The value of GET/POST var, 'CMD'

See also:: init()

Reimplemented in SC_mod_tools_em_index.

Definition at line 137 of file class.t3lib_scbase.php.

t3lib_SCbase::$content = ''

Generally used for accumulating the output content of backend modules

Reimplemented in tx_version_cm1, SC_mod_tools_em_index, SC_mod_user_ws_index, SC_mod_user_ws_workspaceForms, and SC_mod_tools_log_index.

Definition at line 207 of file class.t3lib_scbase.php.

Referenced by SC_mod_user_task_index\description(), tx_recycler_module1\flush(), SC_mod_user_ws_publish\getContent(), tx_scheduler_Module\getModuleContent(), tx_reports_Module\indexAction(), SC_mod_user_task_index\indexAction(), SC_mod_user_ws_publish\main(), tx_scheduler_Module\main(), tx_tsconfighelp_module1\moduleContent(), SC_mod_user_task_index\openInNewWindow(), SC_mod_user_task_index\renderInformationContent(), SC_mod_user_task_index\renderListMenu(), SC_mod_user_task_index\renderModuleContent(), and tx_reports_Module\renderModuleContent().

t3lib_SCbase::$doc

Reimplemented in tx_version_cm1, SC_mod_tools_em_index, SC_mod_user_ws_index, SC_mod_user_ws_workspaceForms, SC_mod_web_func_index, SC_mod_web_info_index, SC_mod_user_ws_publish, SC_mod_tools_log_index, and tx_recycler_module1.

Definition at line 214 of file class.t3lib_scbase.php.

t3lib_SCbase::$extClassConf

Contains module configuration parts from TBE_MODULES_EXT if found

See also:: handleExternalFunctionValue()

Definition at line 195 of file class.t3lib_scbase.php.

t3lib_SCbase::$extObj

May contain an instance of a 'Function menu module' which connects to this backend module.

See also:: checkExtObj()

Definition at line 221 of file class.t3lib_scbase.php.

t3lib_SCbase::$id

The integer value of the GET/POST var, 'id'. Used for submodules to the 'Web' module (page id)

See also:: init()

Definition at line 131 of file class.t3lib_scbase.php.

Referenced by SC_mod_web_ts_index\createTemplate(), tx_tsconfighelp_module1\loadExtensionManual(), tx_tsconfighelp_module1\nextTSDefinitionTable(), tx_tsconfighelp_module1\parseTable(), SC_mod_user_task_index\renderListMenu(), and SC_mod_user_ws_index\workspaceList_getUserListWithAccess().

t3lib_SCbase::$include_once = array()

Contains absolute paths to class files to include from the global scope. This is done in the module index.php files after calling the init() function

See also:: handleExternalFunctionValue()

Definition at line 202 of file class.t3lib_scbase.php.

t3lib_SCbase::$MCONF = array()

Loaded with the global array $MCONF which holds some module configuration from the conf.php file of backend modules.

See also:: init()

Reimplemented in tx_version_cm1, SC_mod_tools_em_index, SC_mod_user_ws_index, SC_mod_user_ws_workspaceForms, and SC_mod_tools_log_index.

Definition at line 125 of file class.t3lib_scbase.php.

t3lib_SCbase::$MOD_MENU

Initial value:

 array(
        'function' => array()
    )

The module menu items array. Each key represents a key for which values can range between the items in the array of that key.

See also:: init()

Reimplemented in tx_version_cm1, SC_mod_tools_em_index, SC_mod_user_ws_index, SC_mod_user_ws_workspaceForms, and SC_mod_tools_log_index.

Definition at line 150 of file class.t3lib_scbase.php.

t3lib_SCbase::$MOD_SETTINGS = array()

Current settings for the keys of the MOD_MENU array

See also:: $MOD_MENU

Reimplemented in tx_version_cm1, SC_mod_tools_em_index, SC_mod_user_ws_index, SC_mod_user_ws_workspaceForms, and SC_mod_tools_log_index.

Definition at line 158 of file class.t3lib_scbase.php.

t3lib_SCbase::$modMenu_dontValidateList = ''

dontValidateList can be used to list variables that should not be checked if their value is found in the MOD_MENU array. Used for dynamically generated menus. Can be set from extension classes of this class before the init() function is called.

See also:: menuConfig(), t3lib_BEfunc::getModuleData()

Reimplemented in SC_mod_web_ts_index.

Definition at line 180 of file class.t3lib_scbase.php.

t3lib_SCbase::$modMenu_setDefaultList = ''

List of default values from $MOD_MENU to set in the output array (only if the values from MOD_MENU are not arrays) Can be set from extension classes of this class before the init() function is called.

See also:: menuConfig(), t3lib_BEfunc::getModuleData()

Reimplemented in SC_mod_web_ts_index.

Definition at line 188 of file class.t3lib_scbase.php.

t3lib_SCbase::$modMenu_type = ''

If type is 'ses' then the data is stored as session-lasting data. This means that it'll be wiped out the next time the user logs in. Can be set from extension classes of this class before the init() function is called.