WB 2.08.x

------------------------------------- 2.7.1 -------------------------------------

!	updated show_menu2 to version 4.7

18-Sep-2008 Thomas Hornik

+	Added captcha-reload

16-Sep-2008 Thomas Hornik

#	search: fixed windows-related regex issue

19-Aug-2008 Matthias Gallas

#	fixed sorting order of search-results

#	fixed an issues related to search, changed one SQL inner join (to use USING instead of WHERE)

!	added $database = new Database(); in front of output-filter

#	fixed MODI_DATE/PUBLISHED_DATE issue in news-module. Added PUBLISHED_TIME, removed PUBL_DATE,PUBL_TIME. Thanks to forum-member timorotha

$module_version = '4.7';

show_menu2, version 4.7

Ist ein Code-Snippet für das CMS Website Baker. Es stellt einen kompletten 

Ersatz für die eingebaute Menüfuntionalität zur Verfügung. Alle, für die 

Erzeugung des Menüs erforderlichen Daten, werden durch eine einzige 

Datenbankabfrage erzeugt. Durch umfangreiche Anpassungsmöglichkeiten des 

erzeugten HTML-Code können alle möglichen Menüarten (Listen, Breadcrumbs, 

Sitemaps, usw.) erzeugt werden.

Deutsche Übersetzung von BerndJM. Dies ist eine weitgehend direkte Übersetzung 

des englischen Originals. Bei Übersetzungs- oder Interpretationsfehlern, bitte 

eine Email an bjm@wwnw.de.

4. Wenn bereits eine frühere Version von show_menu2 installiert ist, diese über

   "Modul deinstallieren" auswählen und deinstallieren.

5. Im Abschnitt "Modul installieren" das im Schritt 1 heruntergeladene zip-File

   auswählen und installieren.

Um show_menu2 zu benutzen muss das verwendete Template an den Stellen 

modifiziert werden, an denen das Menü erscheinen soll. Bitte beachten: Wenn alte 

Menüaufrufe ersetzt werden, müssen unbedingt auch die entsprechenden neuen 

Parameter verwendet werden die show_menu2 benötigt.

In den meisten Fällen genügt bereits der Standardaufruf ohne weitere Parameter 

von show_menu2. In diesem Fall werden die Vorgabewerte verwendet, dies erzeugt 

ein Menü das die aktuelle Seite und die Unterseiten der aktuellen Seite anzeigt:

    show_menu2();

Bitte beachten: der Aufruf von show_menu2 ist PHP und muss normalerweise in PHP-

Codezeichen eingeschlossen werden (ausser der Aufruf erfolgt bereits innerhalb 

von PHP Code):

Dieses Vorgabe Menü erzeugt bereits ein komplettes Menü auf Listenbasis mit 

etlichen Klassen, die eine leichte Formatierung mittels CSS ermöglichen. Es wird 

z.B. die Klasse "menu-current" zu dem <li> tag des aktuellen Menüpunktes 

hinzugefügt. Zusätzlich erhält jeder Menüpunkt der Unterpunkte enthält die 

Klasse "menu-expand". Das erlaubt es sehr differenzierte CSS Regeln für die 

einzelnen Menüpunkte aufzustellen.

Im Abschnitt "HTML-Ausgabe" findet sich eine detaillierte Beschreibung welche 

Klassen welchem Element zugeordnet werden. Durch die Verwendung von 

verschiedenen Parametern bei dem show_menu2 Funktionsaufruf lassen sich auch 

recht umfangreiche und unterschiedliche Menüstrukturen erzeugen. Um 

beispielsweise nur Menüpunkte aus der obersten Ebene der Menüstruktur 

darzustellen, könnte man folgenden Aufruf verwenden:

Es gibt jede Menge Möglichkeiten, um die unterschiedlichsten Menüstrukturen zu 

erzeugen. Zahlreiche Beispiele dazu findet man auf der Demo-Website: http://

code.jellycan.com/sm2test/

HÄUFIGE FRAGEN

==============

Q:  Ich bin kein Programmierer. Gibt es keine einfachere Dokumentation? 

A:  Nein, denn dies hier ist bereits die einfache Dokumentation.

Q:  Wie kann ich ein sogenanntes Drop-Down Menü erstellen?

A:  Dies hat nichts mit show_menu2 zu tun. Um ein Drop-Down Menü zu erzeugen muß

    lediglich der CSS-Code des jeweiligen Templates angepaßt werden. Die nötigen 

    Anpassungen findet man z.B. im "allcss2" Template aus dem WB Addon     

    Repository -> http://addons.websitebaker.org/pages/templates.php

Q:  Warum verschwindet das Menü nachdem ich in einer mehrsprachigen WB-Site die 

    Suchfunktion benutzt habe?

A:  Im verwendeten Template fehlen die notwendigen Zeilen:

    1.  Im WB Admin Backend: Optionen -> Erweiterte Optionen anzeigen ->        

        Suchoptionen -> Kopfzeile - hier direkt nach dem öffnenden <form> tag 

        folgende Zeile einfügen:

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

    2.  In der index.php des verwendeten Templates folgende Zeile unmittelbar   

        nach dem öffnenden <form> tag der Suche einfügen:

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

Q:  Mehrsprachig? Das klingt toll. Wie macht man das?

A:  http://help.websitebaker.org/pages/de/advanced-doku/designer-guide/mehrsprachige-webseiten.php

Q:  Jedesmal wenn eine Seite aufgerufen wird, erzeugt SM2 folgende Warnmeldung:

    "show_menu2 error: $aOptions is invalid. No flags from group 1 supplied!"

A:  Der Funktion wurden die falschen Werte oder eine falsche Anzahl an 

    Werten übergeben.

    Siehe den Abschnitt PARAMETER für die korrekten Flag Werte die dem 

    $aOptions Parameter zu übergeben sind.    

        $aOptions       = SM2_TRIM,

Im Abschnitt "Parameter" findet sich eine detaillierte Beschreibung jedes 

einzelnen Parameters.

Jeder Parameter muß absolut korrekt verwendet werden. Folgende Regeln können 

dabei helfen:

    $aMenu = 0 ist in den meisten Anwendungsfällen der beste Wert.

    $aStart muß entweder eine page ID oder ein Wert der mit "SM2_" beginnt sein.

    $aMaxLevel kann nur Werte erhalten, die mit "SM2_" beginnen.

    $aOptions bis auf einige wenige Spezialfälle sind hier nur Werte die mit 

    "SM2_" beginnen zulässig.

    Alle weiteren Parameter enthalten die (HTML)Tags die die Ausgabe des Menüs 

    steuern.

    Ab $aItemOpen kann jedem Parameter der Wert false übergeben werden um den 

    jeweiligen Vorgabewert zu erhalten.

    Dies kann beispielsweise verwendet werden um eine nummerierte Liste zu 

    erzeugen, während für die einzelnen Menüpunkte trotzdem die Vorgabewerte 

    Verwendung finden:

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

Bitte beachten: bis einschliesslich $aOptions müssen alle Parameter explizit übergeben werden!

Die HTML-Ausgabe hängt wesentlich davon ab, welche Parameter an die Funktion übergeben werden. 

Unabhängig davon werden nachfolgende Klassen grundsätzlich für jedes Menü verwendet, wobei 

einzelne Menüpunkte, wenn es erforderlich ist, auch mehrere Klassen erhalten können.

    KLASSE          ZUORDNUNG

    menu-top        Nur der erste Menüpunkt.

    Folgende Klassen werden nur hinzugefügt, wenn das SM2_NUMCLASS Flag gesetzt 

    ist:

                    beginnend bei 0, des jeweiligen Menüpunktes steht.

    Nummer des Menüs. Diese ist nützlich um mehrere Menüs auf einer Seite zu    

    verwenden.

    Gibt an, ab welcher Ebene die Erzeugung des Menüs beginnen soll. In den     

    meisten Fällen wird dies die oberste Ebene des anzuzeigenden Menüs sein. Es 

    kann einer der folgenden Werte verwendet werden:

                    SM2_ROOT      Beginnt auf der obersten Ebene

                    SM2_ROOT+1    Beginnt eine Ebene unterhalb der obersten Ebene

                    SM2_ROOT+2    Beginnt zwei Ebenen unterhalb der obersten Ebene

                    SM2_CURR      Beginnt auf der aktuellen Ebene. Alle Geschwister

                                  der aktuellen Ebene

                    SM2_CURR+1    Beginnt eine Ebene unterhalb der aktuellen Ebene

                                  mit allen Unterebenen

                    Alle Untermenüs dieser Seite werden angezeigt. 

                    (Die page id kann ermittelt werden, wenn man die Seite im 

                    Admin-Backend editiert, sie steht dann in der Adresszeile des      

                    Browsers: http://SITE/admin/pages/modify.php?page_id=35

    Die maximale Anzahl der Ebenen die angezeigt werden. Die Anzeige

    beginnt ab der in $aStart festgelegten Ebene, bis hin zu der hier 

        SM2_ALL      Keine Beschränkung, alle Ebenen werden angezeigt

                     SM2_CURR      Aktuelle Ebene (keine Unterebene)

                     SM2_CURR+3    Alle übergeordneten + aktuelle + 3 Unterebenen

                     Die Ebenen werden unabhängig davon angezeigt,egal 

                     SM2_START     Eine einzelne Ebene ab der Startebene.

                     SM2_START+1   Startebene + eine Ebene darunter.

                     SM2_MAX       Nur die Startebene (gleiche Wirkung wie SM2_START)

                     SM2_MAX+1     Die Startebene und eine Ebene darunter.

$aOptions   

    sowohl TRIM als auch PRETTY zu definieren, verwendet man: (SM2_TRIM | SM2_PRETTY).

    SM2_NUMCLASS    Fügt die nummerierten Menüklassen "menu-N" und 

                    show_menu2 nicht wiederverwendet sondern erneut aus der Datenbank 

                    gelesen.

                    Zeilenumbrüchen in eine gut lesbare Form. Das ist besonders 

                    nützlich beim Debuggen der Menüausgabe.

                    zwischen und gibt ihn als kompletten String aus.

                    Dieses Flag kann bei Bedarf mit jedem Flag aus der Gruppe 1

                    Abwärtskompatibilität.                   

    Für diesen Parameter gibt es auch einen erweiterten Modus, bei dem die Optionen

    als assoziatives Array übergeben werden. Näheres dazu im Abschnitt ERWEITERTE

    OPTIONEN. Für die meisten Anwendungsfälle wird dies jedoch NICHT benötigt.

    '[li][a][menu_title]</a>' verwendet um die Kompatibilität zur Website Baker

    Standardfunktion show_menu() zu gewährleisten.

    <a> tag angewendet werden, empfiehlt es sich hier folgenden Formatstring zu

    verwendet werden. Die nähere Beschreibung dazu findet sich im Abschnitt FORMATTER. 

    Wenn hier ein Formatter angegeben wird, werden alle Argumente

    nach $aItemOpen ignoriert.

    Dieser String schließt jeden Menüpunkt ab. 

    Dieser String schließt jedes Menü ab. 

ERWEITERTE OPTIONEN

===================

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.

    'flags'     **ZWINGEND ERFORDELICH** Dies sind die Flags die oben im Abschnitt 

                PARAMETER unter $aOptions beschrieben wurden.

    'notrim'    Hiermit wird eine Anzahl von Ebenen festegelegt, die relativ bezogen 

                auf die in $aStart festgelegte Menüebene, immer angezeigt werden. Dies 

                bewirkt, daß für diese Ebenen das SM2_TRIM Flag ignoriert wird.

Um dieses Array zu verwenden, empfiehlt es sich es erst anzulegen und dann den 

$aOptions parameter mit dem angelegten Array zu beliefern:

    $options = array('flags' => (SM2_TRIM|...), 'notrim' => 1);

    show_menu2(0, SM2_ROOT, SM2_CURR+1, $options);

verwendet werden und sollen durch den entsprechenden Text ersetzt werden.

[menu_title]    Text des Menütitel 

                (HTML entity escaped ausser das SM2_NOESCAPE Flag ist gesetzt)

[page_title]    text des Seitentitel 

                (HTML entity escaped ausser das SM2_NOESCAPE Flag ist gesetzt)

[page_id]       die Page ID des aktuellen Menüpunktes.

[parent]        die Page ID des übergeordneten Menüpunktes.

[level]         die Seitenebene, 

                dies ist die gleiche Zahl die im "menu-N" CSS tag verwendet wird.

[sib]           Anzahl der Geschwister des aktuellen Menüpunktes.

[sibCount]      Anzahl aller Geschwister in diesem Menü.

Folgende tags sind NUR verfügbar, wenn das SM2_ALLINFO Flag gesetzt ist.

        Dies kann ein beliebiger String sein, der jedoch nicht das Zeichen '}'

mittels || (boolsches oder - OR) oder && (boolsches und - AND) verknüpft werden.    

Ein einzelner Vergleich besteht aus dem linken Operanden, dem Operator und dem rechten 

Operanden.

        >           Grösser als

                        <number>  die absolute Seitenebene

                        root      die oberste Seitenebene

                        granny    die Seitenebene über der übergeordneten Seitenebene

                        parent    die übergeordnete Seitenebene

                        current   die aktuelle Seitenebene

                        child     die untergeornete Seitenebene

                        <number>  die absolute page id

                        parent    die übergeordnete page id

                        current   die aktuelle page id

    [if(level>parent){exp}]         ist in einem Geschwistermenü oder dem Untermenü eines      

                                    Geschwistermenüs

Wenn eine sonst-Klausel (else) hinzugefügt wird, so wird diese in allen anderen Fällen 

ausgeführt.

    [if(sib == 1 || sib > 3){exp}]  ist der erste Eintrag ODER ist der vierte oder höhere   

    Eintrag im Menü    

    [if(id == current && class == menu-expand){exp}  ist der aktuelle Eintrag UND hat 

    Untermenüs

Die API, die verwendet werden muss, sieht wie folgt aus:

(Anmerkung des Übersetzers: Kommentare sind nicht übersetzt, wer sich so weit vorwagt, sollte

    ** Version 4.7: see README for documentation **

    $aOptions       = SM2_TRIM,

    // extract the flags and set $aOptions to an array

    $flags = 0;

    if (is_int($aOptions)) {

        $flags = $aOptions;

        $aOptions = array();

    }

    else if (isset($aOptions['flags'])) {

        $flags = $aOptions['flags'];

    }

    else {

        $flags = SM2_TRIM;

        $aOptions = array();

        error_log('show_menu2 error: $aOptions is invalid. No flags supplied!');

    }

    if (0 == ($flags & _SM2_GROUP_1)) {

        error_log('show_menu2 error: $aOptions is invalid. No flags from group 1 supplied!');

        $flags |= SM2_TRIM; // default to TRIM

    if (($flags & SM2_NOCACHE) != 0

        if ($flags & SM2_ALLINFO) {

            $formatter->set($flags, $aItemOpen, $aItemClose, 

        // adjust the level until we show everything and ignore the SM2_TRIM flag.

        // Usually this will be less than the start level to disable it.

        $showAllLevel = $aStartLevel - 1;

        if (isset($aOptions['notrim'])) {

            $showAllLevel = $aStartLevel + $aOptions['notrim'];

        }

            $aStartLevel, $showAllLevel, $aMaxLevel, $flags, 

        if (($flags & SM2_BUFFER) != 0) {

    if (($flags & SM2_NOCACHE) != 0) {

    $aStartLevel, $aShowAllLevel, $aMaxLevel, $aFlags, 

            if ($pageLevel > $aShowAllLevel  // permit all levels to be shown

                && !array_key_exists('sm2_on_curr_path', $page)    // not set if false, so existence = true

                $aStartLevel, $aShowAllLevel, $aMaxLevel, $aFlags, 

show_menu2, version 4.7

supplying different parameters to the show_menu2 function call. For example, 

to show only menu items from the top level of the menu you use:

COMMON QUESTIONS

================

Q:  I'm not a programmer. Do you have simpler documentation? 

A:  Nup. This is it. Go hard. Gambarre.

Q:  How do I create a drop-down menu?

A:  This is unrelated to show_menu2. You need to change the template CSS code 

    to display the menu as a drop-down. Try the "allcss2" template from the WB

    addon repository. http://addons.websitebaker.org/pages/templates.php

Q:  Why does the menu disappear after I do a search on my multilingual WB site?

A:  You're missing some required lines in your template.

    1.  Log into WB administration, and go to Settings -> Show advanced settings 

        -> Search Settings -> Header Code and add the following input field 

        after the <form> open tag: 

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

    2.  In the index.php of your template, add the following input field 

        immediately following the search <form> open tag.

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

Q:  Multilingual? That sounds cool. How do I do that?

A:  http://help.websitebaker.org/pages/en/advanced-docu.php

Q:  SM2 is generating a warning every time the page is accessed:

    "show_menu2 error: $aOptions is invalid. No flags from group 1 supplied!"

A:  You are passing the wrong values to the function. Have a closer look at the 

    parameters that you are passing. See the PARAMETERS section below for the 

    correct flag values to pass for the $aOptions parameter.

        $aOptions       = SM2_TRIM,

Ensure that you use each parameter correctly. Use the following rules:

    $aMenu will be 0 for most people.

    $aStart must be either a page ID or a value starting with "SM2_".

    $aMaxLevel must be only values that start with "SM2_".

    $aOptions must be only values that start with "SM2_" (unless you are 

    in a very small minority of users).

    All other parameters are the HTML tag templates that will be 

    output for menus and menu items.

Note that every parameter from $aItemOpen can be supplied as false to get 

the default value.

$aOptions  

    both TRIM and PRETTY you should use, (SM2_TRIM | SM2_PRETTY).

    This parameter also has an extended mode where an associative array of 

    options is supplied. See the EXTENDED OPTIONS section for details. 

    Most users will NOT need to use this.

EXTENDED OPTIONS

================

The $aOptions parameter is a dual mode parameter. For most users, only the

SM2_* flags will be sufficient. However, to access the extra options, it 

must be supplied as an associative array. Note that the SM2_* flags are

still required and must be supplied as 'flags'.

    'flags'     **REQUIRED** These are the flags described in PARAMETERS

                above for the $aOptions parameter. 

    'notrim'    Specify a number of levels relative to the menu level of 

                $aStart that will always be displayed. This will cause the

                SM2_TRIM flag to be ignored for these levels.

To supply one of these options in addition to the flags, the option array 

should be created and passed as the $aOptions parameter:

    $options = array('flags' => (SM2_TRIM|...), 'notrim' => 1);

    show_menu2(0, SM2_ROOT, SM2_CURR+1, $options);