t3lib_extobjbase Class Reference

Inherited by tx_cms_webinfo_lang, tx_cms_webinfo_page, tx_funcwizards_webfunc, tx_infopagetsconfig_webinfo, tx_wizardcrpages_webfunc_2, and tx_wizardsortpages_webfunc_2.

List of all members.

Public Member Functions
	init (&$pObj, $conf)
	Initialize the object.
	handleExternalFunctionValue ()
	If $this->function_key is set (which means there are two levels of object connectivity) then $this->extClassConf is loaded with the TBE_MODULES_EXT configuration for that sub-sub-module.
	incLocalLang ()
	Including any locallang file configured and merging its content over the current global LOCAL_LANG array (which is EXPECTED to exist!!!).
Public Attributes
	$pObj
	Contains a reference to the parent object.
	$thisPath = ''
	Set to the directory name of this class file.
	$localLangFile = 'locallang.php'
	Can be hardcoded to the name of a locallang.php file (from the same directory as the class file) to use/load.
	$extClassConf
	Contains module configuration parts from TBE_MODULES_EXT if found.
	$function_key = ''
	If this value is set it points to a key in the TBE_MODULES_EXT array (not on the top level..) where another classname/filepath/title can be defined for sub-subfunctions.

---

Member Function Documentation

t3lib_extobjbase::handleExternalFunctionValue (   )

If $this->function_key is set (which means there are two levels of object connectivity) then $this->extClassConf is loaded with the TBE_MODULES_EXT configuration for that sub-sub-module. Returns: void See also: $function_key, tx_funcwizards_webfunc::init() Definition at line 221 of file class.t3lib_extobjbase.php. References t3lib_BEfunc::getModuleData(). Referenced by tx_funcwizards_webfunc::init(). { // Must clean first to make sure the correct key is set... $this->pObj->MOD_SETTINGS = t3lib_BEfunc::getModuleData($this->pObj->MOD_MENU, t3lib_div::_GP('SET'), $this->pObj->MCONF['name']); if ($this->function_key) { $this->extClassConf = $this->pObj->getExternalItemConfig($this->pObj->MCONF['name'],$this->function_key,$this->pObj->MOD_SETTINGS[$this->function_key]); if (is_array($this->extClassConf) && $this->extClassConf['path']) { $this->pObj->include_once[] = $this->extClassConf['path']; } } }

t3lib_extobjbase::incLocalLang (   )

Including any locallang file configured and merging its content over the current global LOCAL_LANG array (which is EXPECTED to exist!!!). Returns: void Same as t3lib_SCbase::checkExtObj() Returns: void See also: t3lib_SCbase::checkExtObj() Calls the main function inside ANOTHER sub-submodule which might exist. Returns: void Dummy function - but is used to set up additional menu items for this submodule. For an example see the extension 'cms' where the 'web_info' submodule is defined in cms/web_info/class.tx_cms_webinfo.php, tx_cms_webinfo_page::modMenu() Returns: array A MOD_MENU array which will be merged together with the one from the parent object See also: init(), tx_cms_webinfo_page::modMenu() Definition at line 237 of file class.t3lib_extobjbase.php. References $LANG, and $LOCAL_LANG. Referenced by init().

t3lib_extobjbase::init (  &$  pObj, $  conf )

Initialize the object. Parameters: object  A reference to the parent (calling) object (which is probably an instance of an extension class to t3lib_SCbase) array  The configuration set for this module - from global array TBE_MODULES_EXT Returns: void See also: t3lib_SCbase::checkExtObj() Reimplemented in tx_funcwizards_webfunc. Definition at line 197 of file class.t3lib_extobjbase.php. References incLocalLang(). { global $LANG; $this->pObj = &$pObj; // Path of this script: $this->thisPath = dirname($conf['path']); if (!@is_dir($this->thisPath)) { die('Error: '.$this->thisPath.' was not a directory as expected...'); } // Local lang: $this->incLocalLang(); // Setting MOD_MENU items as we need them for logging: $this->pObj->MOD_MENU = array_merge($this->pObj->MOD_MENU,$this->modMenu()); // Candidate for t3lib_div::array_merge() if integer-keys will some day make trouble... }

---

Member Data Documentation

t3lib_extobjbase::$extClassConf

Contains module configuration parts from TBE_MODULES_EXT if found. See also: handleExternalFunctionValue() Definition at line 170 of file class.t3lib_extobjbase.php.

t3lib_extobjbase::$function_key = ''

If this value is set it points to a key in the TBE_MODULES_EXT array (not on the top level..) where another classname/filepath/title can be defined for sub-subfunctions. This is a little hard to explain, so see it in action; it used in the extension 'func_wizards' in order to provide yet a layer of interfacing with the backend module. The extension 'func_wizards' has this description: 'Adds the 'Wizards' item to the function menu in Web>Func. This is just a framework for wizard extensions.' - so as you can see it is designed to allow further connectivity - 'level 2' See also: handleExternalFunctionValue(), tx_funcwizards_webfunc Reimplemented in tx_funcwizards_webfunc. Definition at line 179 of file class.t3lib_extobjbase.php.

t3lib_extobjbase::$localLangFile = 'locallang.php'

Can be hardcoded to the name of a locallang.php file (from the same directory as the class file) to use/load. See also: incLocalLang() Definition at line 163 of file class.t3lib_extobjbase.php.

t3lib_extobjbase::$pObj

Contains a reference to the parent object. See also: init() Definition at line 151 of file class.t3lib_extobjbase.php.

t3lib_extobjbase::$thisPath = ''

Set to the directory name of this class file. See also: init() Definition at line 157 of file class.t3lib_extobjbase.php.

---

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

• t3lib/class.t3lib_extobjbase.php

---