TYPO3\CMS\Frontend\ContentObject\Menu\TextMenuContentObject Class Reference

Inheritance diagram for TYPO3\CMS\Frontend\ContentObject\Menu\TextMenuContentObject:

Public Member Functions
	generate ()
string	writeMenu ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject
bool	start ($tmpl, $sys_page, $id, $conf, $menuNumber, $objSuffix='')
	makeMenu ()
bool	filterMenuPages (&$data, $banUidArray, $isSpacerPage)
PageRepository	getSysPage ()
ContentObjectRenderer	getParentContentObject ()
	setParentMenu (array $menuArr, $menuItemKey)
array	getParentMenuArr ()
array null	getParentMenuItem ()

Protected Member Functions
string	getBeforeAfter ($pref)
	extProc_afterLinking ($key)
string	extProc_finish ()
‪Protected Member Functions inherited from ‪TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject
array	removeInaccessiblePages (array $pages)
array	prepareMenuItems ()
array	prepareMenuItemsForUserSpecificMenu ($specialValue, $sortingField)
array	prepareMenuItemsForLanguageMenu ($specialValue)
array	prepareMenuItemsForDirectoryMenu ($specialValue, $sortingField)
array	prepareMenuItemsForUpdatedMenu ($specialValue, $sortingField)
array	prepareMenuItemsForKeywordsMenu ($specialValue, $sortingField)
array	prepareMenuItemsForRootlineMenu ()
array	prepareMenuItemsForBrowseMenu ($specialValue, $sortingField, $additionalWhere)
array	processItemStates ($splitCount)
array	link ($key, $altTarget, $typeOverride)
array	determineOriginalShortcutPage (array $page)
	changeLinksForAccessRestrictedPages (&$LD, $page, $mainTarget, $typeOverride)
string	subMenu ($uid, $objSuffix)
bool	isNext ($uid, $MPvar)
bool	isActive ($uid, $MPvar)
bool	isCurrent ($uid, $MPvar)
bool	isSubMenu ($uid)
bool	isItemState ($kind, $key)
array	accessKey ($title)
mixed	userProcess ($mConfKey, $passVar)
	setATagParts ()
string	getPageTitle ($title, $nav_title)
string	getMPvar ($key)
string	getDoktypeExcludeWhere ()
array	getBannedUids ()
array	menuTypoLink ($page, $oTarget, $addParams, $typeOverride, ?int $overridePageId=null)
array	sectionIndex ($altSortField, $pid=null)
TypoScriptFrontendController	getTypoScriptFrontendController ()
	getCurrentLanguageAspect ()
TimeTracker	getTimeTracker ()
TYPO3 CMS Core Cache Frontend FrontendInterface	getCache ()
TYPO3 CMS Core Cache Frontend FrontendInterface	getRuntimeCache ()
SiteInterface	getCurrentSite ()
bool	hasParentMenuArr ()
	hasParentMenuItemKey ()
	hasParentMenuItem ()

Additional Inherited Members
‪Public Attributes inherited from ‪TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject
ContentObjectRenderer	$parent_cObj
‪Protected Attributes inherited from ‪TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject
int	$menuNumber = 1
int	$entryLevel = 0
int[]	$excludedDoktypes = array( PageRepository::DOKTYPE_BE_USER_SECTION, PageRepository::DOKTYPE_SYSFOLDER )
int[]	$alwaysActivePIDlist = array( )
string[]	$MP_array = array( )
array	$conf = array( )
array	$mconf = array( )
TemplateService	$tmpl
PageRepository	$sys_page
int	$id
string	$nextActive
array[]	$menuArr
string	$hash
array	$result = array( )
array	$rL_uidRegister
mixed[]	$I
string	$WMresult
int	$WMmenuItems
array[]	$WMsubmenuObjSuffixes
ContentObjectRenderer	$WMcObj
string	$alternativeMenuTempArray = ''
int null	$parentMenuArrItemKey
array	$parentMenuArr
const	customItemStates

Detailed Description

Extension class creating text based menus

Definition at line 24 of file TextMenuContentObject.php.

Member Function Documentation

extProc_afterLinking()

TYPO3\CMS\Frontend\ContentObject\Menu\TextMenuContentObject::extProc_afterLinking (   $key )

protected

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

int

$key

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

See also

‪writeMenu()

Definition at line 195 of file TextMenuContentObject.php.

References TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject\subMenu().

Referenced by TYPO3\CMS\Frontend\ContentObject\Menu\TextMenuContentObject\writeMenu().

extProc_finish()

string TYPO3\CMS\Frontend\ContentObject\Menu\TextMenuContentObject::extProc_finish ( )

protected

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

Returns

‪string The total menu content should be returned by this function

See also

‪writeMenu()

Definition at line 211 of file TextMenuContentObject.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\Menu\TextMenuContentObject\writeMenu().

generate()

TYPO3\CMS\Frontend\ContentObject\Menu\TextMenuContentObject::generate

(

)

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

See also

‪AbstractMenuContentObject::processItemStates()

Reimplemented from TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject.

Definition at line 32 of file TextMenuContentObject.php.

References debug(), and TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject\processItemStates().

getBeforeAfter()

string TYPO3\CMS\Frontend\ContentObject\Menu\TextMenuContentObject::getBeforeAfter (   $pref )

protected

Generates the before* and after* stdWrap for TMENUs Evaluates:

• ‪before.stdWrap*
• ‪beforeWrap
• ‪after.stdWrap*
• ‪afterWrap

Parameters

string

$pref

‪Can be "before" or "after" and determines which kind of stdWrap to process (basically this is the prefix of the TypoScript properties that are read from the ->I['val'] array

Returns

‪string The resulting HTML

Definition at line 179 of file TextMenuContentObject.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\Menu\TextMenuContentObject\writeMenu().

writeMenu()

string TYPO3\CMS\Frontend\ContentObject\Menu\TextMenuContentObject::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. An instance of ContentObjectRenderer 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(); )

Reimplemented from TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject.

Definition at line 55 of file TextMenuContentObject.php.

References $GLOBALS, TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject\accessKey(), TYPO3\CMS\Frontend\ContentObject\Menu\TextMenuContentObject\extProc_afterLinking(), TYPO3\CMS\Frontend\ContentObject\Menu\TextMenuContentObject\extProc_finish(), TYPO3\CMS\Frontend\ContentObject\Menu\TextMenuContentObject\getBeforeAfter(), TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject\getPageTitle(), TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject\link(), TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject\setATagParts(), and TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject\userProcess().