TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
TextMenuContentObject Class Reference
Inheritance diagram for TextMenuContentObject:
AbstractMenuContentObject

Public Member Functions

 generate ()
 
 writeMenu ()
 
 getBeforeAfter ($pref)
 
 extProc_init ()
 
 extProc_beforeLinking ($key)
 
 extProc_afterLinking ($key)
 
 extProc_beforeAllWrap ($item, $key)
 
 extProc_finish ()
 
- Public Member Functions inherited from AbstractMenuContentObject
 start ($tmpl, $sys_page, $id, $conf, $menuNumber, $objSuffix= '')
 
 makeMenu ()
 
 generate ()
 
 writeMenu ()
 
 filterMenuPages (&$data, $banUidArray, $spacer)
 
 procesItemStates ($splitCount)
 
 link ($key, $altTarget= '', $typeOverride= '')
 
 changeLinksForAccessRestrictedPages (&$LD, $page, $mainTarget, $typeOverride)
 
 isNext ($uid, $MPvar= '')
 
 isActive ($uid, $MPvar= '')
 
 isCurrent ($uid, $MPvar= '')
 
 isSubMenu ($uid)
 
 isItemState ($kind, $key)
 
 accessKey ($title)
 
 userProcess ($mConfKey, $passVar)
 
 setATagParts ()
 
 getPageTitle ($title, $nav_title)
 
 getMPvar ($key)
 
 getDoktypeExcludeWhere ()
 
 getBannedUids ()
 
 menuTypoLink ($page, $oTarget, $no_cache, $script, $overrideArray= '', $addParams= '', $typeOverride= '')
 
 getSysPage ()
 
 getParentContentObject ()
 
 setParentMenu (array $menuArr=[], $menuItemKey)
 
 getParentMenuArr ()
 
 getParentMenuItem ()
 

Additional Inherited Members

- Public Attributes inherited from AbstractMenuContentObject
 $menuNumber = 1
 
 $entryLevel = 0
 
 $spacerIDList = '199'
 
 $doktypeExcludeList = '6'
 
 $alwaysActivePIDlist = []
 
 $imgNamePrefix = 'img'
 
 $imgNameNotRandom = 0
 
 $debug = false
 
 $parent_cObj = null
 
 $GMENU_fixKey = 'gmenu'
 
 $MP_array = []
 
 $conf = []
 
 $mconf = []
 
 $tmpl = null
 
 $sys_page = null
 
 $id
 
 $nextActive
 
 $menuArr
 
 $hash
 
 $result = []
 
 $rL_uidRegister
 
 $INPfixMD5
 
 $I
 
 $WMresult
 
 $WMfreezePrefix
 
 $WMmenuItems
 
 $WMsubmenuObjSuffixes
 
 $WMextraScript
 
 $WMcObj = null
 
 $alternativeMenuTempArray = ''
 
 $nameAttribute = 'name'
 
 $parentMenuArr = []
 
- Protected Member Functions inherited from AbstractMenuContentObject
 removeInaccessiblePages (array $pages)
 
 prepareMenuItemsForUserSpecificMenu ($specialValue, $sortingField)
 
 prepareMenuItemsForLanguageMenu ($specialValue)
 
 prepareMenuItemsForDirectoryMenu ($specialValue, $sortingField)
 
 prepareMenuItemsForUpdatedMenu ($specialValue, $sortingField)
 
 prepareMenuItemsForKeywordsMenu ($specialValue, $sortingField)
 
 prepareMenuItemsForRootlineMenu ()
 
 prepareMenuItemsForBrowseMenu ($specialValue, $sortingField, $additionalWhere)
 
 determineOriginalShortcutPage (array $page)
 
 sectionIndex ($altSortField, $pid=null)
 
 getTypoScriptFrontendController ()
 
 getTimeTracker ()
 
 getCache ()
 
 getRuntimeCache ()
 
 hasParentMenuArr ()
 
 hasParentMenuItemKey ()
 
 hasParentMenuItem ()
 
- Protected Attributes inherited from AbstractMenuContentObject
 $useCacheHash = false
 
 $parentMenuArrItemKey
 

Detailed Description

Extension class creating text based menus

Definition at line 20 of file TextMenuContentObject.php.

Member Function Documentation

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
int$keyPointer to $this->menuArr[$key] where the current menu element record is found
Returns
void private
See also
writeMenu()

Definition at line 234 of file TextMenuContentObject.php.

Referenced by TextMenuContentObject\writeMenu().

extProc_beforeAllWrap (   $item,
  $key 
)

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

Parameters
string$itemThe current content of the menu item, $this->I['theItem'], passed along.
int$keyPointer 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()

Definition at line 253 of file TextMenuContentObject.php.

Referenced by TextMenuContentObject\writeMenu().

extProc_beforeLinking (   $key)

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

Parameters
int$keyPointer to $this->menuArr[$key] where the current menu element record is found
Returns
void private
See also
writeMenu()

Definition at line 221 of file TextMenuContentObject.php.

Referenced by TextMenuContentObject\writeMenu().

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

Definition at line 265 of file TextMenuContentObject.php.

References AbstractMenuContentObject\$WMextraScript.

Referenced by TextMenuContentObject\writeMenu().

extProc_init ( )

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

Returns
void private
See also
writeMenu()

Definition at line 209 of file TextMenuContentObject.php.

Referenced by TextMenuContentObject\writeMenu().

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
AbstractMenuContentObject::procesItemStates()

Definition at line 29 of file TextMenuContentObject.php.

References debug(), and AbstractMenuContentObject\procesItemStates().

getBeforeAfter (   $pref)

Generates the before* and after* images for TMENUs

Parameters
string$prefCan 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.

Definition at line 176 of file TextMenuContentObject.php.

References $GLOBALS.

Referenced by TextMenuContentObject\writeMenu().

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

Definition at line 52 of file TextMenuContentObject.php.

References $GLOBALS, AbstractMenuContentObject\$INPfixMD5, AbstractMenuContentObject\accessKey(), TextMenuContentObject\extProc_afterLinking(), TextMenuContentObject\extProc_beforeAllWrap(), TextMenuContentObject\extProc_beforeLinking(), TextMenuContentObject\extProc_finish(), TextMenuContentObject\extProc_init(), TextMenuContentObject\getBeforeAfter(), AbstractMenuContentObject\getPageTitle(), AbstractMenuContentObject\link(), AbstractMenuContentObject\setATagParts(), and AbstractMenuContentObject\userProcess().