Documentation TYPO3 par Ameos

t3lib_extobjbase Class Reference

Inheritance diagram for t3lib_extobjbase:
[legend]
List of all members.

Public Member Functions

 init (&$pObj, $conf)
 handleExternalFunctionValue ()
 incLocalLang ()
 checkExtObj ()
 extObjContent ()
 modMenu ()

Public Attributes

 $pObj
 $thisPath = ''
 $localLangFile = 'locallang.php'
 $extClassConf
 $function_key = ''

Detailed Description

Definition at line 145 of file class.t3lib_extobjbase.php.


Member Function Documentation

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 $pObj, and incLocalLang().

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_div::_GP(), and t3lib_BEfunc::getModuleData().

Referenced by tx_funcwizards_webfunc::init().

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

Definition at line 237 of file class.t3lib_extobjbase.php.

References t3lib_div::array_merge_recursive_overrule().

Referenced by init().

t3lib_extobjbase::checkExtObj (  ) 

Same as t3lib_SCbase::checkExtObj()

Returns:
void
See also:
t3lib_SCbase::checkExtObj()

Definition at line 253 of file class.t3lib_extobjbase.php.

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

t3lib_extobjbase::extObjContent (  ) 

Calls the main function inside ANOTHER sub-submodule which might exist.

Returns:
void

Definition at line 268 of file class.t3lib_extobjbase.php.

Referenced by tx_funcwizards_webfunc::main().

t3lib_extobjbase::modMenu (  ) 

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()

Reimplemented in tx_belog_webinfo, tx_cms_webinfo_page, tx_cms_webinfo_lang, tx_funcwizards_webfunc, tx_indexedsearch_modfunc1, tx_infopagetsconfig_webinfo, tx_lowlevel_cleaner, tx_tstemplateanalyzer, tx_tstemplateinfo, tx_tstemplateobjbrowser, tx_wizardcrpages_webfunc_2, and tx_wizardsortpages_webfunc_2.

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


Member Data Documentation

t3lib_extobjbase::$pObj

Contains a reference to the parent object.

See also:
init()

Definition at line 151 of file class.t3lib_extobjbase.php.

Referenced by tx_funcwizards_webfunc::init(), and init().

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.

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()

Reimplemented in tx_belog_webinfo.

Definition at line 163 of file class.t3lib_extobjbase.php.

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.


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


Généré par TYPO3 Ameos avec  doxygen 1.4.6