Multiple Menus

show_menu2, version 4.9x

Show_Menu2 is a code snippet for the CMS WebsiteBaker. Since WebsiteBaker 2.7 it is included with the CMS.
The former show_menu function is completely replaced and extended with show_menu2. All data required to create the menu is generated by a single database query. By extensive adjustment possibilities of the generated HTML code all possible menu types (lists, breadcrumbs, sitemaps, etc.) can be generated.

• Installation
• Using Show_Menu2
• FAQ
• Function
• HTML Output
• Parameter
• Advanced Options
• Format Strings
• Conditional Formatting
• Formatter

INSTALLATION up

Since show_menu2 is usually present in WebsiteBaker, no installation is required. If, contrary to expectations, it does not exist, you can download it here .

Using SHOW_MENU2 up

To use show_menu2 you have to modify the template where you want the menu to appear. Please note: If old menu calls are replaced, the corresponding new parameters that show_menu2 needs must also be used.

In most cases the standard call with at least 4 parameters of show_menu2 is sufficient. In this case the default values are used, this creates a menu that displays the current page and the subpages of the current page:

show_menu2(0, SM2_ROOT, SM2_START, SM2_TRIM);

Please note: the call to show_menu2 is PHP and must normally be enclosed in PHP code characters (unless the call is already inside PHP code):

 <?php show_menu2(0, SM2_ROOT, SM2_START, SM2_TRIM); ?>

This default menu already creates a complete menu on a list basis with several classes that allow easy formatting using CSS. For example, the class "menu-current" is added to the <li> tag of the current menu item. Additionally each menu item of the subitems contains the class "menu-expand". This allows to create very differentiated CSS rules for each menu item.
For example:

li.menu-expand { font-weight: bold; }
li.menu-current { background: red; }

The section "HTML Output" contains a detailed description of which classes are assigned to which element. By using different parameters in the show_menu2 function call, it is also possible to create quite extensive and different menu structures. For example, to display only menu items from the top level of the menu structure, you could use the following call:

show_menu2(0, SM2_ROOT, SM2_START, SM2_TRIM);

Or, for example, to display up to two sublevels of the current page:

show_menu2(0, SM2_CURR+1, SM2_CURR+2, SM2_TRIM);

There are a lot of possibilities to create different menu structures. Numerous examples can be found on the demo website: KLICK

FAQ up

Q: I'm not a programmer. Is there no simpler documentation?
A: No, because this is already the simple documentation.

Q: How can I create a drop-down menu?
A: This has nothing to do with show_menu2. To create a drop-down menu you only have to adjust the CSS code of the respective template. The necessary adjustments can be found e.g. in the "allcss2" template from the WebsiteBaker Addon Repository -> https://addon.websitebaker.org/

Q: Why does the menu disappear after I have used the search function in a multilingual WebsiteBaker page?
A: The necessary lines are missing in the template used:

<input type="hidden" name="referrer" value="[REFERRER_ID]" />

<input type="hidden" name="referrer" value="<?php echo defined('REFERRER_ID')?REFERRER_ID:PAGE_ID;?>" />

Q: Multilingual? That sounds great. How do you do it?
A: https://help.websitebaker.org/en/designerguide/multilingual-websites.php

Q: Each time a page is called, SM2 generates the following warning message:
"show_menu2 error: $aOptions is invalid. No flags from group 1 supplied!"
A: The wrong values or a wrong number of values were passed to the function.
See the PARAMETERS section for the correct flag values to pass to the $aOptions parameter.

Q: How do I use a different class/picture/color/widget for each entry in a menu?
A: Use the [page_id] format string in the $aItemOpen string. Create a unique class or id for each menu item, then reference that item in your CSS or Javascript to do whatever you want.
To add a unique class for each menu item (or similar):

"<li><a href="[url]" target="[target]" class="[class] p[page_id]">[menu_title]</a>"

... creating menu items like ...

<li><a href="/pages/foo/bar.php" target="_top" class="menu-top p45">Top Menu</a>

Reference this in your CSS like:

a.p45 { color: red; }

To add a unique ID for each menu item (or similar):

"<li><a id="p[page_id]" href="[url]" target="[target]" class="[class]">[menu_title]</a>"

... creating menu items like ...

<li><a id="p45" href="/pages/foo/bar.php" target="_top" class="menu-top">Top Menu</a>

Reference this in your CSS like:

a#p45 { color: red; }

Note that the ID can only be used if that menu is generated and displayed one time only on the page (because HTML ID's must be unique within a page).

FUNCTION up

The complete call and the default parameter values for show_menu2 are as follows:

show_menu2(
  $aMenu = 0,
  $aStart = SM2_ROOT,
  $aMaxLevel = SM2_CURR+1,
  $aOptions = SM2_TRIM,
  $aItemOpen = '[li][a][menu_title]</a>',
  $aItemClose = '</li>',
  $aMenuOpen = '[ul]',
  $aMenuClose = '</ul>',
  $aTopItemOpen = false,
  $aTopMenuOpen = false
);

The "Parameters" section contains a detailed description of each individual parameter.
Each parameter must be used absolutely correctly. The following rules can help:

$aMenu = 0 is the best value in most cases.
$aStart must be either a page ID or a value starting with "SM2_".
$aMaxLevel can only get values starting with "SM2_".
$aOptions except for a few special cases only values beginning with "SM2_" are allowed.
All other parameters contain the (HTML)tags that control the output of the menu.
Starting from $aItemOpen each parameter can be passed the value false to get the respective default value.

This can be used, for example, to create a numbered list, while the default values are still used for the individual menu items:

show_menu2(0, SM2_ROOT, SM2_ALL, SM2_ALL, false, false, '<ol>', '</ol>');

Please note: up to and including $aOptions all parameters must be passed explicitly!

HTML Output up

The HTML output depends largely on which parameters are passed to the function. Irrespective of this, subsequent classes are always used for each menu, whereby individual menu items can also have several classes if necessary.

Example of HTML output:

<ul class="menu-top menu-0">
  <li class="menu-0 menu-first"> ... </li>
  <li class="menu-0 menu-expand menu-parent"> ...
  <ul class="menu-1">
    <li class="menu-1 menu-expand menu-first"> ...
    <ul class="menu-2">
        <li class="menu-2 menu-first"> ...
        <li class="menu-2 menu-last"> ...
    </ul>
    </li>
    <li class="menu-1 menu-expand menu-parent"> ...
    <ul class="menu-2">
        <li class="menu-2 menu-expand menu-current menu-first"> ... ** CURRENT PAGE **
        <ul class="menu-3">
            <li class="menu-3 menu-child menu-child-0 menu-first"> ...
            <ul class="menu-4">
                <li class="menu-4 menu-child menu-child-1 menu-first"> ... </li>
                <li class="menu-4 menu-child menu-child-1 menu-last"> ... </li>
            </ul>
            </li>
            <li class="menu-3 menu-child menu-child-0 menu-last"> ... </li>
        </ul>
        </li>
        <li class="menu-2 menu-sibling menu-last"> ... </li>
    </ul>
    </li>
    <li class="menu-1"> ... </li>
    <li class="menu-1 menu-expand menu-last"> ...
    <ul class="menu-2">
        <li class="menu-2 menu-first menu-last"> ... </li>
    </ul>
    </li>
  </ul>
  </li>
  <li class="menu-0 menu-last"> ... </li>
 </ul>
 

PARAMETER up

$aMenu

$aStart

$aMaxLevel

$aOptions

 A-1 -> B-1
     -> B-2  -> C-1
             -> C-2 (CURRENT)
                       -> D-1
                       -> D-2
             -> C-3
 A-2 -> B-3
     -> B-4

 A-1 -> B-1
     -> B-2  -> C-1
             -> C-2 (CURRENT)
                       -> D-1
                       -> D-2
             -> C-3
 A-2 

A-1 -> B-2 -> C-2 (CURRENT)

 A-1 -> B-2 -> C-1
            -> C-2 (CURRENT)
                     -> D-1
                     -> D-2
            -> C-3
            

$aItemOpen

$aItemClose

$aMenuOpen

$aMenuClose

$aTopItemOpen

$aTopMenuOpen

ADVANCED OPTIONS up

Der Parameter $aOptions kann auf zweierlei Arten verwendet werden. Zum einen, wie oben im Abschnitt PARAMETER beschrieben, diese Art sollte für die allermeisten Anwendungsfälle ausreichen. Um allerdings in speziellen Fällen die Sonderoptionen ansprechen zu können, müssen die erforderlichen Werte als assoziatives Array bereitgestellt werden.
Bitte beachten: Die SM2_* Flags sind auch hierbei erforderlich und müßen als 'flags' übergeben werden.

$options = array('flags' => (SM2_TRIM|...), 'notrim' => 1);
 show_menu2(0, SM2_ROOT, SM2_CURR+1, $options);

FORMAT STRINGS up

The following tags can be used in the format strings for $aItemOpen and $aMenuOpen and should be replaced by the corresponding text.

'<a href="[url]" target="[target]">'

'<a href="[url]" target="[target]" class="[class]">'

'<li class="[class]">'

'<ul class="[class]">'

The following tags are ONLY available if the SM2_ALLINFO flag is set.

Conditional Formatting up

The conditional formatting statement can take one of the following forms:

[if(A){B}]
[if(A){B}else{C}]

The condition is a combination of one or more boolean comparisons.
If more than one comparison is required, it must be combined with the other comparisons
can be linked using || (boolean or - OR) or && (boolean and - AND).

A single comparison consists of the left operand, the operator and the right operand.
e.g. X == Y - where X is the left operand, == the operator and Y the right operand.

If an else clause is added, it will be executed in all other cases.

For example, "foo" is always executed when the if check is wrong, so:

Please note:
All checks will be performed in the order in which they are noted, because:

• There is no check for possible loops (all checks are always executed).
• Checks are not grouped (parentheses of checks are not supported)
• Both these things have the same value.

FORMATTER up

Attention: This is an advanced and rarely used feature!

With extensive knowledge in PHP programming it is possible to use the predefined
Formatting of show_menu2 with your own.
In the include.php of show_menu2 you can see how to write the formatter.
The API that must be used looks like this:

class SM2_Formatter
{
 // called once before any menu is processed to allow object initialization
 function initialize() { }
 // called to open the menu list
 function startList($aPage, $aUrl) { }
 // called to open the menu item
 function startItem($aPage, $aUrl, $aCurrSib, $aSibCount) { }
 // called to close the menu item
 function finishItem() { }
 // called to close the menu list
 function finishList() { }
 // called once after all menu has been processed to allow object finalization
 function finalize() { }
 // called once after finalize() if the SM2_NOOUTPUT flag is used
 function getOutput() { }
};

WebsiteBaker is released under the GNU General Public License