wNavigation::createNavigationXML

Navigation

Startseite

Dokumentationen

PHP-Framework

Generiert eine Navigation

Funktionsaufruf

String createNavigationXML(String data, String mode, String navId, Array options = array())

Parameter

data

Pfad der Navigationsdatei

mode

Modus der Navigation

sitemap: Alle Navigationspunkte werden geliefert. Falls diese Unterpunkte haben, sind sie geöffnet.
sitemapRoot: Alle Navigationspunkte des ausgewählten Zweiges werden geliefert. Falls diese Unterpunkte haben, sind sie geöffnet.
treeAll: Alle Navigationspunkte werden geliefert, und wie bei tree geöffnet.
treeRoot: Alle Navigationspunkte des ausgewählten Zweiges werden geliefert, und wie bei tree geöffnet.
tree: Nur erste Ebene, sowie ausgewählte Navigationspunkte, deren Geschwister und deren direkte Unterpunkte werden zur Darstellung geliefert.
breadcrumb: Nur die Vorfahren sowie der aktuelle Navigationspunkt wird geliefert.

navId

NavId des aktuellen Menüpunktes

options

Zusätzliche Einstellungen

deep: Gibt an, wie viele Level berücksichtigt werden sollen
root: Falls eine Navigation-ID angegeben ist, werden nur die Unterpunkte des angegebenen Navigationspunktes als Navigation berücksichtigt
rootOnly: Falls das Wurzelelement, welches über das Attribut root angegeben wurde, nicht existiert, wird ein leerer Baum zurückgegeben
checkOnline [|off]: Verhindert, das der Online-Status geprüft wird
checkPersonalization [|off]: Verhindert, das die Personalisierung geprüft wird
expires: Gültigkeit in Sekunden, bevor die Navigation neu generiert wird
expiresUser: Gültigkeit in Sekunden, bevor die Navigation neu generiert wird, falls der Benutzer eingeloggt ist
navidExpires: Navigations-ID, die als Basis für den Cache genutzt wird. Falls nichts definiert ist, wird immer die Standard Navigations-ID genutzt. Ändert sich die Navigation z.B. nicht abhängig vom ausgewählten Navigationspunkt, kann ein konstanter Wert angegeben werden.
project: Projektpfad für den Cache, falls die Funktion über ein Skript statt innerhalb eines Inhaltsprojektes aufgerufen wird.

Beispiel:

Quelltext


<?php

//Generiert eine Navigation in XML
  $navigationStr = wNavigation::createNavigationXML('/dev/wGlobal/content/navigations/standard.wNavigation.php', 'sitemap', '', array('expires' => 10, 'project' => '/dev'));

  print $navigationStr;

?>

Hinweis
Beim Einsatz von Framework-Funktionen in eigenen Skripten beachten Sie bitte den Artikel "So verwenden Sie das PHP-Framework in eigenen Scripten".
Wenn Sie eine Funktion innerhalb einer Weblication® Seite z.B. über das PHP-Quelltext Element oder in einem XSL-Template über wsl:php einbinden, muss das Framework über die grid.php nicht mehr referenziert werden.