Main Page | Directories | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages | Examples

tx_funcwizards_webfunc Class Reference

Inherits t3lib_extobjbase.

List of all members.

Public Member Functions

 init (&$pObj, $conf)
 Initialize.
 modMenu ()
 Modifies parent objects internal MOD_MENU array, adding items this module needs.
 main ()
 Creation of the main content.

Public Attributes

 $function_key = 'wiz'
 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

tx_funcwizards_webfunc::init &$  pObj,
conf
 

Initialize.

Calls parent init function and then the handleExternalFunctionValue() function from the parent class

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_extobjbase::handleExternalFunctionValue(), t3lib_extobjbase::init()

Reimplemented from t3lib_extobjbase.

Definition at line 78 of file class.tx_funcwizards_webfunc.php.

References t3lib_extobjbase::handleExternalFunctionValue().

00078                                  {
00079          // OK, handles ordinary init. This includes setting up the menu array with ->modMenu
00080       parent::init($pObj,$conf);
00081 
00082          // Making sure that any further external classes are added to the include_once array. Notice that inclusion happens twice in the main script because of this!!!
00083       $this->handleExternalFunctionValue();
00084    }

tx_funcwizards_webfunc::main  ) 
 

Creation of the main content.

Calling extObjContent() to trigger content generation from the sub-sub modules

Returns:
string The content
See also:
t3lib_extobjbase::extObjContent()

Definition at line 111 of file class.tx_funcwizards_webfunc.php.

References $content, $LANG, and menu().

00111                      {
00112       global $SOBE,$LANG;
00113 
00114       $menu= $LANG->getLL('wiz_lWizards',1).': '.t3lib_BEfunc::getFuncMenu($this->pObj->id,'SET[wiz]',$this->pObj->MOD_SETTINGS['wiz'],$this->pObj->MOD_MENU['wiz']);
00115       $theOutput.=$this->pObj->doc->section('','<span class="nobr">'.$menu.'</span>');
00116 
00117       $content = '';
00118       $content.=$theOutput;
00119       $content.=$this->pObj->doc->spacer(5);
00120       $content.=$this->extObjContent();
00121 
00122       return $content;
00123    }

tx_funcwizards_webfunc::modMenu  ) 
 

Modifies parent objects internal MOD_MENU array, adding items this module needs.

Returns:
array Items merged with the parent objects.
See also:
t3lib_extobjbase::init()

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

References menu(), and t3lib_BEfunc::unsetMenuItems().

00092                         {
00093       global $LANG;
00094 
00095       $modMenuAdd = array(
00096          $this->function_key => array()
00097       );
00098 
00099       $modMenuAdd[$this->function_key] = $this->pObj->mergeExternalItems($this->pObj->MCONF['name'],$this->function_key,$modMenuAdd[$this->function_key]);
00100       $modMenuAdd[$this->function_key] = t3lib_BEfunc::unsetMenuItems($this->pObj->modTSconfig['properties'],$modMenuAdd[$this->function_key],'menu.'.$this->function_key);
00101 
00102       return $modMenuAdd;
00103    }


Member Data Documentation

tx_funcwizards_webfunc::$function_key = 'wiz'
 

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 from t3lib_extobjbase.

Definition at line 67 of file class.tx_funcwizards_webfunc.php.


The documentation for this class was generated from the following file:
Generated on Sun Oct 3 01:07:51 2004 for TYPO3core 3.7.0 dev by  doxygen 1.3.8-20040913