.. include:: /Includes.rst.txt .. index:: TMENU .. _tmenu: ===== TMENU ===== .. note:: :typoscript:`TMENU` is a menu object type. In TYPO3 v10 the remaining other menu types got removed so :typoscript:`TMENU` is the only menu type left. .. contents:: :local: .. index:: TMENU; Item states .. _tmenu-common-properties: TMENU item states ================= These properties are all the item states used by TMENU. .. note:: Order of priority: USERDEF2, USERDEF1, SPC, USR, CURIFSUB, CUR, ACTIFSUB, ACT, IFSUB, NO. .. ### BEGIN~OF~TABLE ### NO -- .. container:: table-row Property NO Data type boolean / (config) Default 1 (true) Description The default "Normal" state rendering of Item. This is required for all menus. If you specify properties for the "NO" property you do not have to set it "1". Otherwise with no properties setting "NO=1" will render the menu anyways (for TMENU this may make sense). The simplest menu TYPO3 can generate is then: .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/setup.typoscript page.20 = HMENU page.20.1 = TMENU page.20.1.NO = 1 That will be pure tags wrapped around page titles. IFSUB ----- .. container:: table-row Property IFSUB Data type boolean / (config) Default 0 Description Enable/Configuration for menu items which has subpages. ACT --- .. container:: table-row Property ACT Data type boolean / (config) Default 0 Description Enable/Configuration for menu items which are found in the rootLine. ACTIFSUB -------- .. container:: table-row Property ACTIFSUB Data type boolean / (config) Default 0 Description Enable/Configuration for menu items which are found in the rootLine and have subpages. CUR --- .. container:: table-row Property CUR Data type boolean / (config) Default 0 Description Enable/Configuration for a menu item if the item is the current page. CURIFSUB -------- .. container:: table-row Property CURIFSUB Data type boolean / (config) Default 0 Description Enable/Configuration for a menu item if the item is the current page and has subpages. USR --- .. container:: table-row Property USR Data type boolean / (config) Default 0 Description Enable/Configuration for menu items which are access restricted pages that a user has access to. SPC --- .. container:: table-row Property SPC Data type boolean / (config) Default 0 Description Enable/Configuration for 'Spacer' pages. Spacers are pages of the doktype "Spacer". These are not viewable pages but "placeholders" which can be used to divide menu items. USERDEF1 -------- .. container:: table-row Property USERDEF1 Data type boolean / (config) Description Userdefined, see .itemArrayProcFunc for details on how to use this. You can set the ITEM\_STATE values USERDEF1 and USERDEF2 (+...RO) from a script/user function processing the menu item array. See the property .itemArrayProcFunc of the menu objects. USERDEF2 -------- .. container:: table-row Property USERDEF2 Data type boolean / (config) Description (See above) .. ###### END~OF~TABLE ###### [tsref:(cObject).HMENU.(mObj\_itemStates)] .. _menu-common-properties: .. index:: TMENU; properties Properties ========== .. ### BEGIN~OF~TABLE ### expAll ------ .. container:: table-row Property expAll Data type boolean /:ref:`stdWrap ` Description If this is true, the menu will always show the menu on the level underneath the menu item. This corresponds to a situation where a user has clicked a menu item and the menu folds out the next level. This can enable that to happen on all items as default. collapse -------- .. container:: table-row Property collapse Data type boolean Description If set, the "active" menu item that has expanded the next level on the menu will now collapse that menu again. .. index:: TMENU; sectionIndex .. _section-index: sectionIndex ------------ If this property is set, then the menu will not consist of links to pages on the "next level" but rather of links to the parent page to the menu, and in addition "#"-links to the cObjects rendered on the page. In other words, the menu items will be a section index with links to the content elements on the page (by default with colPos=0!). .. container:: table-row Property sectionIndex Data type boolean Description If you set this, all content elements (from tt\_content table) of "Column" = "Normal" *and* the "Index"-check box clicked are selected. This corresponds to the "Menu/Sitemap" content element when "Section index" is selected as type. sectionIndex.type ~~~~~~~~~~~~~~~~~ .. container:: table-row Property sectionIndex.type Data type string ("all" / "header") Description "all" The "Index"-checkbox is not considered and all content elements - by default with colPos=0 - are selected. "header" Only content elements with a visible header-layout (and a non-empty 'header'-field!) are selected. In other words, if the header layout of an element is set to "Hidden" then the page will not appear in the menu. sectionIndex.includeHiddenHeaders ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property sectionIndex.includeHiddenHeaders Data type boolean Description If you set this and sectionIndex.type is set to "header", also elements with a header layout set to "Hidden" will appear in the menu. sectionIndex.useColPos ~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property sectionIndex.useColPos Data type integer /:ref:`stdWrap ` Default 0 Description This property allows you to set the colPos which should be used in the where clause of the query. Possible values are integers, default is "0". Any positive integer and 0 will lead to a where clause containing "colPos=x" with x being the aforementioned integer. A negative value drops the filter "colPos=x" completely. .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/setup.typoscript tt_content.menu.20.3.1.sectionIndex.useColPos = -1 The data record in sectionIndex menus ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ When the menu-records are selected it works like this: The parent page record is used as the "base" for the menu-record. That means that any "no\_cache" or "target"-properties of the parent page are used for the whole menu. But of course some fields from the tt\_content records are transferred. This is how it is mapped: .. code-block:: none :caption: Example of data mapping $temp[$row[uid]]=$basePageRow; $temp[$row[uid]]['title']=$row['header']; $temp[$row[uid]]['subtitle']=$row['subheader']; $temp[$row[uid]]['starttime']=$row['starttime']; $temp[$row[uid]]['endtime']=$row['endtime']; $temp[$row[uid]]['fe_group']=$row['fe_group']; $temp[$row[uid]]['media']=$row['media']; $temp[$row[uid]]['header_layout']=$row['header_layout']; $temp[$row[uid]]['bodytext']=$row['bodytext']; $temp[$row[uid]]['image']=$row['image']; $temp[$row[uid]]['sectionIndex_uid']=$row['uid']; Basically this shows that - the field "header" and "subheader" from tt\_content are mapped to "title" and "subtitle" in the pages-record. Thus you shouldn't need to change your standard menu objects to fit this thing. - the fields "starttime", "endtime", "fe\_group", "media" from tt\_content are mapped to the same fields in a pages-record. - the fields "header\_layout", "bodytext" and "image" are mapped to non-existing fields in the page-record - a new field, "sectionIndex\_uid" is introduced in the page record which is detected by the `\TYPO3\CMS\Frontend\Typolink\PageLinkBuilder`. If this field is present in a page record, the `PageLinkBuilder` will prepend a hash-mark and the number of the field. .. note:: You cannot create submenus to sectionIndex menus. These elements are not pages and thereby have no children. .. _tmenu-target: target ------ .. container:: table-row Property accessKey Data type boolean Description If set access-keys are set on the menu-links .. container:: table-row Property target Data type target Default self Description Target of the menu links forceTypeValue --------------- .. container:: table-row Property forceTypeValue Data type integer Description If set, the &type parameter of the link is forced to this value regardless of target. stdWrap ------- .. container:: table-row Property stdWrap Data type :ref:`stdWrap ` Description Wraps the whole block of sub items. **Example:** : .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/setup.typoscript 2 = TMENU 2 { stdWrap.dataWrap =
    |
NO { // ... } } wrap ---- .. container:: table-row Property wrap Data type :ref:`wrap ` Description Wraps the whole block of sub items, but only if there were items in the menu! IProcFunc --------- .. container:: table-row Property IProcFunc Data type function name Description The internal array "I" is passed to this function and expected returned as well. Subsequent to this function call the menu item is compiled by implode()'ing the array $I[parts] in the passed array. Thus you may modify this if you need to. See example in the extension statictemplates (statictemplates/media/scripts/example\_itemArrayProcFunc.php). Item States ----------- .. container:: table-row Property [Item States, like NO, ACT, CUR etc] Data type ->TMENUITEM Description This is the TMENUITEM-options for each category of a menu item that can be generated. **Special:** The ->OptionSplit function is run on the whole configuration before the items are generated. alternativeSortingField ----------------------- .. container:: table-row Property alternativeSortingField Data type string Description Normally the menu items are sorted by the fields "sorting" in the pages- and tt\_content-table. Here you can enter a list of fields that is used in the SQL- "ORDER BY" statement instead. You can also provide the sorting order. **Examples (for "pages" table):** alternativeSortingField = title desc (This will render the menu in reversed alphabetical order.) **Limitations:** This property works with normal menus, sectionsIndex menus and special-menus of type "directory". minItems -------- .. container:: table-row Property minItems Data type integer / :ref:`stdWrap ` Description The minimum items in the menu. If the number of pages does not reach this level, a dummy-page with the title "..." and uid=[currentpage\_id] is inserted. Takes precedence over :ref:`HMENU.minItems `. maxItems -------- .. container:: table-row Property maxItems Data type integer / :ref:`stdWrap ` Description The maximum items in the menu. More items will be ignored. Takes precedence over HMENU.maxItems. begin ----- .. container:: table-row Property begin Data type integer / :ref:`stdWrap ` :ref:`+calc ` Description The first item in the menu. **Example:** This results in a menu, where the first two items are skipped starting with item number 3: .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/setup.typoscript begin = 3 Takes precedence over :ref:`HMENU.begin `. debugItemConf ------------- .. container:: table-row Property debugItemConf Data type boolean Description Outputs (by the :php:`debug()` function) the configuration arrays for each menu item. Useful to debug :ref:`optionsplit` things and such... overrideId ---------- .. container:: table-row Property overrideId Data type integer (page-id) Description If set, then all links in the menu will point to this pageid. Instead the real uid of the page is sent by the parameter "&real\_uid=[uid]". This feature is smart, if you have inserted a menu from somewhere else, perhaps a shared menu, but wants the menu items to call the same page, which then generates a proper output based on the real\_uid. addParams --------- .. container:: table-row Property addParams Data type string Description Additional parameter for the menu-links. **Example:** "&some\_var=some%20value" Must be rawurlencoded. .. index:: TMENU; showAccessRestrictedPages .. _menu-common-properties-showaccessrestrictedpages: showAccessRestrictedPages -------------------------- .. container:: table-row Property showAccessRestrictedPages Data type integer (page id) / keyword "NONE" Description If set, pages in the menu will include pages with frontend user group access enabled. However the page is of course not accessible and therefore the URL in the menu will be linked to the page with the ID of this value. On that page you could put a login form or other message. If the value is "NONE" the link will not be changed and the site will perform page-not-found handling when clicked (which can be used to capture the event and act accordingly of course). This means that the link's URL will point to the page even if it is not accessible by the current frontend user. Note that the default behavior of page-not-found handling is to show the parent page instead. **Properties:** .addParam = Additional parameter for the URL, which can hold two markers; ###RETURN\_URL### which will be substituted with the link the page would have had if it had been accessible and ###PAGE\_ID### holding the page id of the page coming from (could be used to look up which fe\_groups was required for access. **Example:** : .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/setup.typoscript showAccessRestrictedPages = 22 showAccessRestrictedPages.addParams = &return_url=###RETURN_URL###&pageId=###PAGE_ID### The example will link access restricted menu items to page id 22 with the return URL in the GET var "return\_url" and the page id in the GET var "pageId". additionalWhere --------------- .. container:: table-row Property additionalWhere Data type string / :ref:`stdWrap ` Description Adds an additional part to the WHERE clause for this menu. Make sure to start the part with "AND "! **Example:** : .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/setup.typoscript lib.authormenu = HMENU lib.authormenu.1 = TMENU lib.authormenu.1.additionalWhere = AND author!="" itemArrayProcFunc ----------------- .. container:: table-row Property itemArrayProcFunc Data type function name Description The first variable passed to this function is the "menuArr" array with the menu items as they are collected based on the type of menu. You're free to manipulate or add to this array as you like. Just remember to return the array again! **Note:** .parentObj property is **hardcoded** to be a reference to the calling typo3/sysext/frontend/Classes/ContentObject/Menu/ object. Here you'll find e.g. ->id to be the uid of the menu item generating a submenu and such. **Presetting element state** You can override element states like SPC, IFSUB, ACT, CUR or USR by setting the key ITEM\_STATE in the page records. submenuObjSuffixes ------------------ .. container:: table-row Property submenuObjSuffixes Data type string +optionSplit Description Defines a suffix for alternative sub-level menu objects. Useful to create special submenus depending on their parent menu element. See example below. **Example:** This example will generate a menu where the menu objects for the second level will differ depending on the number of the first level item for which the submenu is rendered. The second level objects used are "2" (the default), "2a" and "2b" (the alternatives). Which of them is used is defined by "1.submenuObjSuffixes" which has the configuration "a \|\*\| \|\*\| b". This configuration means that the first menu element will use configuration "2a" and the last will use "2b" while anything in between will use "2" (no suffix applied) : .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/setup.typoscript page.200 = HMENU page.200 { 1 = TMENU 1.wrap =
|
1.expAll = 1 1.submenuObjSuffixes = a |*| |*| b 1.NO.allWrap = |
2 = TMENU 2.NO.allWrap =
|
2a = TMENU 2a.NO.allWrap =
|
2b = TMENU 2b.NO.allWrap =
|
} The result can be seen in the image below: .. figure:: /Images/ManualScreenshots/FrontendOutput/Hmenu/MenuObjectsCommonPropertiesSubmenuObjSuffixes.png :alt: Output of the above example. Applies to TMENU on >= 2 :sup:`nd` level in a menu. .. ###### END~OF~TABLE ###### [tsref:(cObject).HMENU.(mObj).TMENU]