TYPO3 4.1.0: tslib_gmenu Class Reference

tslib_gmenu::generate ( )

Calls procesItemStates() so that the common configuration for the menu items are resolved into individual configuration per item. Calls makeGifs() for all "normal" items and if configured for, also the "rollover" items.

Returns:: void

See also:: tslib_menu::procesItemStates(), makeGifs()

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

tslib_gmenu::makeGifs	(	$	conf,
		$	resKey
	)

Will traverse input array with configuratoin per-item and create corresponding GIF files for the menu. The data of the files are stored in $this->result

Parameters:

	array	Array with configuration for each item.
	string	Type of images: normal ("NO") or rollover ("RO"). Valid values are "NO" and "RO"

Returns:: void private

See also:: generate()

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

tslib_gmenu::findLargestDims	(	$	conf,
		$	items,
		$	Hobjs,
		$	Wobjs,
		$	minDim,
		$	maxDim
	)

Function searching for the largest width and height of the menu items to be generated. Uses some of the same code as makeGifs and even instantiates some gifbuilder objects BUT does not render the images - only reading out which width they would have. Remember to upgrade the code in here if the makeGifs function is updated.

Parameters:

	array	Same configuration array as passed to makeGifs()
	integer	The number of menu items
	array	Array with "applyTotalH" numbers
	array	Array with "applyTotalW" numbers
	array	Array with "min" x/y
	array	Array with "max" x/y

Returns:: array Array with keys "H" and "W" which are in themselves arrays with the heights and widths of menu items inside. This can be used to find the max/min size of the menu items. private

See also:: makeGifs()

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

tslib_gmenu::writeMenu ( )

Traverses the ->result['NO'] array of menu items configuration (made by ->generate()) and renders the HTML of each item (the images themselves was made with makeGifs() before this. See ->generate()) 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 GMENU_LAYERS

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

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

tslib_gmenu::extProc_init ( )

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

Returns:: void private

See also:: writeMenu(), tslib_gmenu_layers::extProc_init()

Reimplemented in tslib_gmenu_foldout, and tslib_gmenu_layers.

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

tslib_gmenu::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 OR $this->result['RO'][$key] where the configuration for that elements RO version is found!

Returns:: void private

See also:: writeMenu(), tslib_gmenu_layers::extProc_RO()

Reimplemented in tslib_gmenu_layers.

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

tslib_gmenu::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_gmenu_layers::extProc_beforeLinking()

Reimplemented in tslib_gmenu_foldout, and tslib_gmenu_layers.

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

tslib_gmenu::extProc_afterLinking ( $ key )

Called right after the creation of links for the menu item. This is also the last function call before the for-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. Further this calls the subMenu function in the parent class to create any submenu there might be.

Parameters:

integer

Pointer to $this->menuArr[$key] where the current menu element record is found

Returns:: void private

See also:: writeMenu(), tslib_gmenu_layers::extProc_afterLinking(), tslib_menu::subMenu()

Reimplemented in tslib_gmenu_foldout, and tslib_gmenu_layers.

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

tslib_gmenu::extProc_beforeAllWrap	(	$	item,
		$	key
	)

Called before the "wrap" 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_gmenu_layers::extProc_beforeAllWrap()

Reimplemented in tslib_gmenu_layers.

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

tslib_gmenu::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_gmenu_layers::extProc_finish()

Reimplemented in tslib_gmenu_foldout, and tslib_gmenu_layers.

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


Public Member Functions
	generate ()
	makeGifs ($conf, $resKey)
	findLargestDims ($conf, $items, $Hobjs, $Wobjs, $minDim, $maxDim)
	writeMenu ()
	extProc_init ()
	extProc_RO ($key)
	extProc_beforeLinking ($key)
	extProc_afterLinking ($key)
	extProc_beforeAllWrap ($item, $key)
	extProc_finish ()

Documentation TYPO3 par Ameos

tslib_gmenu Class Reference

Public Member Functions

Detailed Description

Member Function Documentation