SCWlib: Breadcrumbs

PHP-Klasse zum Erzeugen einer Brotkrumen-Navigation (Breadcrumb-Navigation).

Autor:	Tim Gerundt [LGm]
E-Mail:	lgm@lgmsworld.de
Homepage:	www.lgmsworld.de

Lizenz

This library is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

http://www.gnu.org/licenses/lgpl.html

Anleitung

Zum Benutzen muß man die Datei scwlib_breadcrumbs.php mit include oder require einbinden.

Methoden

Folgende Methoden stehen zur Verfügung:

void setPutIntoDivision(bool $value, string $cssclass = '', string $cssid = '')
Legt fest, ob die Brotkrumen-Navigation in einen Bereich <div> gepackt werden soll.
Ausserdem kann man eine optionale CSS-Klasse und/oder CSS-ID angeben.

Standard: false, '', ''
void setPutIntoParagraph(bool $value, string $cssclass = '', string $cssid = '')
Legt fest, ob die Brotkrumen-Navigation in einen Absatz <p> gepackt werden soll.
Ausserdem kann man eine optionale CSS-Klasse und/oder CSS-ID angeben.

Standard: false, '', ''
void setDescription(string $description)
Legt die Beschreibung vor der Brotkrumen-Navigation fest.

Standard: Sie befinden sind hier:
void setHomeName(string $homename)
Legt den Anzeigenamen der Startseite fest.

Standard: Startseite
void setHomePath(string $homepath)
Legt den Pfad der Startseite fest.

Standard: /
void setSeparator(string $separator)
Legt das Trennzeichen der Brotkrumen fest.

Standard: >
void setReplaceUnderlines(bool $value)
Legt fest, ob der Unterstrich "_" in den Brotkrumen ersetzt werden soll.

Standard: false
void setUppercaseFirst(bool $value)
Legt fest, ob das erste Zeichen jedes Brotkrumen GROSS geschrieben werden soll.

Standard: false
void setUppercaseWords(bool $value)
Legt fest, ob jedes erstes Zeichen eines Wortes innerhalb eines Brotkrumen GROSS geschrieben werden soll.

Standard: false
void setRemoveExtension(bool $value)
Legt fest, ob die Dateierweiterung entfernt werden soll.

Standard: true
void setReadTitleFromPage(bool $value)
Legt fest, ob der Titel aus der Seite gelesen werden soll.

Standard: false
void setTitlePattern(string $titlepattern)
Legt das Suchmuster (als Perl-kompatibler regulärer Ausdruck) für den Titel fest.

Standard: <title>(.*?)<\/title>
void clearReplacements()
Löscht die Ersetzungen.
void addReplacement(string $search, string $replace)
Fügt eine Ersetzungen hinzu.
void setUseReplacements(bool $value)
Legt fest, ob Ersetzungen verwendet werden sollen.

Standard: false
string getBreadcrumbs()
Liefert die Brotkrumen-Navigation zurück.
void printBreadcrumbs()
Gibt die Brotkrumen-Navigation aus.

Beispiel

<?php
 include('scwlib_breadcrumbs.php'); //Datei einbinden
 
 $breadcrumbs = new SCWlib_Breadcrumbs; //Objekt erzeugen
 
 $breadcrumbs->setDescription('Du bist hier: '); //Neue Beschreibung
 $breadcrumbs->setSeparator(' &raquo; '); //Trennzeichen: »
 $breadcrumbs->setReplaceUnderlines(true); //Unterstrich "_" ersetzen
 $breadcrumbs->setUppercaseFirst(true); //Erster Buchstabe = Großbuchstabe
 
 $breadcrumbs->addReplacement('gaestebuch', 'g&uml;stebuch'); //gaestebuch -> gästebuch
 $breadcrumbs->setUseReplacements(true); //Ersetzungen verwenden
 
 $breadcrumbs->printBreadcrumbs(); //Brotkrumen einfügen
?>

Der Pfad /deutsch/gaestebuch/anzeigen.php würde dann folgende Ausgabe ergeben:

Du bist hier: Startseite » Deutsch » Gästebuch » Anzeigen

Voraussetzungen

PHP ab der Version 3.0.9.
Reguläre Ausdrücke Funktionen (Perl-Kompatibel)

Viel Spaß mit der Klasse!

Tim Gerundt

Version

0.2.7: Methode setPutIntoParagraph um den optionalen Parameter $cssid erweitert.; Methode setPutIntoDivision hinzugefügt.
0.2.6: Erste offizielle Version.