TMENU¶
Note
TMENU is a menu object type. In TYPO3 v10 the remaining other menu types
got removed so TMENU is the only menu type left.
Properties¶
expAll¶
Property
expAll
Data type
boolean /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¶
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.
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!).
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¶
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.useColPos¶
Property
sectionIndex.useColPos
Data type
integer /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.
tt_content.menu.20.3.1.sectionIndex.useColPos = -1
target¶
Property
accessKey
Data type
boolean
Description
If set access-keys are set on the menu-links
Property
target
Data type
target
Default
self
Description
Target of the menu links
forceTypeValue¶
Property
forceTypeValue
Data type
integer
Description
If set, the &type parameter of the link is forced to this value regardless of target.
wrap¶
Property
wrap
Data type
Description
Wraps the whole block of sub items, but only if there were items in the menu!
IProcFunc¶
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¶
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¶
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¶
Property
minItems
Data type
integer / 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 HMENU.minItems.
maxItems¶
Property
maxItems
Data type
integer / stdWrap
Description
The maximum items in the menu. More items will be ignored.
Takes precedence over HMENU.maxItems.
begin¶
Property
begin
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:
begin = 3
Takes precedence over HMENU.begin.
debugItemConf¶
Property
debugItemConf
Data type
boolean
Description
Outputs (by the debug()-function) the configuration arrays for each menu item. Useful to debug optionSplit things and such...
overrideId¶
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¶
Property
addParams
Data type
string
Description
Additional parameter for the menu-links.
Example:
"&some_var=some%20value"
Must be rawurlencoded.
showAccessRestrictedPages¶
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: :
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¶
Property
additionalWhere
Data type
string / stdWrap
Description
Adds an additional part to the WHERE clause for this menu. Make sure to start the part with "AND "!
Example: :
lib.authormenu = HMENU
lib.authormenu.1 = TMENU
lib.authormenu.1.additionalWhere = AND author!=""
itemArrayProcFunc¶
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¶
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) :
page.200 = HMENU
page.200 {
1 = TMENU
1.wrap = <div style="width:200px; border: 1px solid;">|</div>
1.expAll = 1
1.submenuObjSuffixes = a |*| |*| b
1.NO.allWrap = <b>|</b><br/>
2 = TMENU
2.NO.allWrap = <div style="background:red;">|</div>
2a = TMENU
2a.NO.allWrap = <div style="background:yellow;">|</div>
2b = TMENU
2b.NO.allWrap = <div style="background:green;">|</div>
}
The result can be seen in the image below:
Applies to TMENU on >= 2 nd level in a menu.
[tsref:(cObject).HMENU.(mObj).TMENU]