Documentation TYPO3 par Ameos

tslib_tmenu Class Reference

Inheritance diagram for tslib_tmenu:

Inheritance graph
[legend]
Collaboration diagram for tslib_tmenu:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 generate ()
 writeMenu ()
 getBeforeAfter ($pref)
 addJScolorShiftFunction ()
 extProc_init ()
 extProc_RO ($key)
 extProc_beforeLinking ($key)
 extProc_afterLinking ($key)
 extProc_beforeAllWrap ($item, $key)
 extProc_finish ()

Detailed Description

Definition at line 1530 of file class.tslib_menu.php.


Member Function Documentation

tslib_tmenu::addJScolorShiftFunction  ) 
 

Adds a JavaScript function to the $GLOBALS['TSFE']->additionalJavaScript array

Returns:
void private
See also:
writeMenu()

Definition at line 1729 of file class.tslib_menu.php.

Referenced by writeMenu().

tslib_tmenu::extProc_afterLinking key  ) 
 

Called right after the creation of links for the menu item. This is also the last function call before the while-loop traversing menu items goes to the next item. This function MUST set $this->WMresult.=[HTML for menu item] to add the generated menu item to the internal accumulation of items.

Parameters:
integer Pointer to $this->menuArr[$key] where the current menu element record is found
Returns:
void private
See also:
writeMenu(), tslib_tmenu_layers::extProc_afterLinking()

Reimplemented in tslib_tmenu_layers.

Definition at line 1785 of file class.tslib_menu.php.

Referenced by writeMenu().

tslib_tmenu::extProc_beforeAllWrap item,
key
 

Called before the "allWrap" happens on the menu item.

Parameters:
string The current content of the menu item, $this->I['theItem'], passed along.
integer Pointer to $this->menuArr[$key] where the current menu element record is found
Returns:
string The modified version of $item, going back into $this->I['theItem'] private
See also:
writeMenu(), tslib_tmenu_layers::extProc_beforeAllWrap()

Reimplemented in tslib_tmenu_layers.

Definition at line 1802 of file class.tslib_menu.php.

Referenced by writeMenu().

tslib_tmenu::extProc_beforeLinking key  ) 
 

Called right before the creation of the link for the menu item

Parameters:
integer Pointer to $this->menuArr[$key] where the current menu element record is found
Returns:
void private
See also:
writeMenu(), tslib_tmenu_layers::extProc_beforeLinking()

Reimplemented in tslib_tmenu_layers.

Definition at line 1773 of file class.tslib_menu.php.

Referenced by writeMenu().

tslib_tmenu::extProc_finish  ) 
 

Called before the writeMenu() function returns (only if a menu was generated)

Returns:
string The total menu content should be returned by this function private
See also:
writeMenu(), tslib_tmenu_layers::extProc_finish()

Reimplemented in tslib_tmenu_layers.

Definition at line 1813 of file class.tslib_menu.php.

Referenced by writeMenu().

tslib_tmenu::extProc_init  ) 
 

Called right before the traversing of $this->result begins. Can be used for various initialization

Returns:
void private
See also:
writeMenu(), tslib_tmenu_layers::extProc_init()

Reimplemented in tslib_tmenu_layers.

Definition at line 1751 of file class.tslib_menu.php.

Referenced by writeMenu().

tslib_tmenu::extProc_RO key  ) 
 

Called after all processing for RollOver of an element has been done.

Parameters:
integer Pointer to $this->menuArr[$key] where the current menu element record is found
Returns:
void private
See also:
writeMenu(), tslib_tmenu_layers::extProc_RO()

Reimplemented in tslib_tmenu_layers.

Definition at line 1762 of file class.tslib_menu.php.

Referenced by writeMenu().

tslib_tmenu::generate  ) 
 

Calls procesItemStates() so that the common configuration for the menu items are resolved into individual configuration per item. Sets the result for the new "normal state" in $this->result

Returns:
void
See also:
tslib_menu::procesItemStates()

Definition at line 1539 of file class.tslib_menu.php.

References tslib_menu::procesItemStates().

tslib_tmenu::getBeforeAfter pref  ) 
 

Generates the before* and after* images for TMENUs

Parameters:
string Can be "before" or "after" and determines which kind of image to create (basically this is the prefix of the TypoScript properties that are read from the ->I['val'] array
Returns:
string The resulting HTML of the image, if any. &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=388&cHash=a7486044cd

Definition at line 1699 of file class.tslib_menu.php.

References tslib_cObj::getBorderAttr(), and t3lib_div::png_to_gif_by_imagemagick().

Referenced by writeMenu().

tslib_tmenu::writeMenu  ) 
 

Traverses the ->result array of menu items configuration (made by ->generate()) and renders each item. During the execution of this function many internal methods prefixed "extProc_" from this class is called and many of these are for now dummy functions. But they can be used for processing as they are used by the TMENU_LAYERS An instance of tslib_cObj is also made and for each menu item rendered it is loaded with the record for that page so that any stdWrap properties that applies will have the current menu items record available.

Returns:
string The HTML for the menu (returns result through $this->extProc_finish(); )

Definition at line 1555 of file class.tslib_menu.php.

References addJScolorShiftFunction(), extProc_afterLinking(), extProc_beforeAllWrap(), extProc_beforeLinking(), extProc_finish(), extProc_init(), extProc_RO(), getBeforeAfter(), tslib_menu::getPageTitle(), tslib_menu::link(), t3lib_div::makeInstance(), tslib_menu::setATagParts(), t3lib_div::trimExplode(), and tslib_menu::userProcess().


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


Généré par Le spécialiste TYPO3 avec  doxygen 1.4.6