Solutions Open Source
Solutions Open Source
Fonctions membres publiques | |
| init () | |
| menuConfig () | |
| mergeExternalItems ($modName, $menuKey, $menuArr) | |
| handleExternalFunctionValue ($MM_key='function', $MS_value=NULL) | |
| getExternalItemConfig ($modName, $menuKey, $value='') | |
| checkExtObj () | |
| checkSubExtObj () | |
| extObjHeader () | |
| extObjContent () | |
Attributs publics | |
| $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 | |
| t3lib_SCbase::init | ( | ) |
Initializes the backend module by setting internal variables, initializing the menu.
Réimplémentée dans SC_mod_tools_em_index, SC_mod_user_ws_index, SC_mod_user_ws_publish, SC_mod_user_ws_workspaceForms, SC_mod_tools_log_index, et SC_mod_web_ts_index.
| 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.
Réimplémentée dans SC_mod_tools_em_index, SC_mod_user_ws_index, SC_mod_tools_log_index, tx_dbal_module1, et tx_version_cm1.
| t3lib_SCbase::mergeExternalItems | ( | $ | modName, | |
| $ | menuKey, | |||
| $ | menuArr | |||
| ) |
Merges menu items from global array $TBE_MODULES_EXT
| 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. |
| 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
| 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) |
Réimplémentée dans SC_mod_tools_em_index.
| 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.
| 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... |
| 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.
| t3lib_SCbase::checkSubExtObj | ( | ) |
Calls the checkExtObj function in sub module if present.
| 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(' ...
| t3lib_SCbase::extObjContent | ( | ) |
Calls the 'main' function inside the "Function menu module" if present
| t3lib_SCbase::$MCONF = array() |
Loaded with the global array $MCONF which holds some module configuration from the conf.php file of backend modules.
Réimplémentée dans SC_mod_tools_em_index, SC_mod_user_ws_index, SC_mod_user_ws_workspaceForms, SC_mod_tools_log_index, et tx_version_cm1.
| t3lib_SCbase::$id |
The integer value of the GET/POST var, 'id'. Used for submodules to the 'Web' module (page id)
| t3lib_SCbase::$CMD |
| t3lib_SCbase::$perms_clause |
A WHERE clause for selection records from the pages table based on read-permissions of the current backend user.
Réimplémentée dans SC_mod_web_ts_index.
| t3lib_SCbase::$MOD_MENU |
Valeur initiale :
Array (
'function' => array()
)
Réimplémentée dans SC_mod_tools_em_index, SC_mod_user_ws_index, SC_mod_user_ws_workspaceForms, SC_mod_tools_log_index, et tx_version_cm1.
| t3lib_SCbase::$MOD_SETTINGS = array() |
Current settings for the keys of the MOD_MENU array
Réimplémentée dans SC_mod_tools_em_index, SC_mod_user_ws_index, SC_mod_user_ws_workspaceForms, SC_mod_tools_log_index, et tx_version_cm1.
| t3lib_SCbase::$modTSconfig |
Module TSconfig based on PAGE TSconfig / USER TSconfig
| 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.
Réimplémentée dans SC_mod_web_ts_index.
| 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.
Réimplémentée dans SC_mod_web_ts_index.
| 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.
Réimplémentée dans SC_mod_web_ts_index.
| t3lib_SCbase::$extClassConf |
Contains module configuration parts from TBE_MODULES_EXT if found
| 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
| t3lib_SCbase::$content = '' |
Generally used for accumulating the output content of backend modules
Réimplémentée dans SC_mod_tools_em_index, SC_mod_user_ws_index, SC_mod_user_ws_workspaceForms, SC_mod_tools_log_index, et tx_version_cm1.
| t3lib_SCbase::$doc |
Generally used to hold an instance of the 'template' class from typo3/template.php
Réimplémentée dans SC_mod_tools_em_index, SC_mod_user_ws_index, SC_mod_user_ws_workspaceForms, SC_mod_tools_log_index, et tx_version_cm1.
| t3lib_SCbase::$extObj |
May contain an instance of a 'Function menu module' which connects to this backend module.
1.5.3