Twig-Funktionen

Neben den Standard-Funktionen von Twig stehen in Herbie die folgenden Funktionen zur Verfügung.

absurl

Gibt zu einer bestimmten Route die absolute URL aus.

string absurl(string route)
route string Die Route zu einer Seite.
[return] string Die absolute URL zu einer Route.

addcss

Fügt ein CSS-Asset hinzu.

addcss(array|strong paths[, attr = []][, group = null][, raw = false][, pos = 1])
paths string|array Ein oder mehrere Pfade zu CSS-Ressourcen.
attr array Attribute für das HTML-Tag. []
group string Ein Name zur Gruppierung des CSS. null
raw bool Gibt das CSS direkt aus anstatt als Link. false
pos int Beeinflusst die Reihenfolge der Ausgabe. -1
[return] void

addjs

Fügt ein Js-Asset hinzu.

addjs(array|strong paths[, attr = []][, group = null][, raw = false][, pos = 1])
paths string|array Ein oder mehrere Pfade zu JavaScript-Ressourcen.
attr array Attribute für das HTML-Tag. []
group string Ein Name zur Gruppierung des JavaScript. null
raw bool Gibt das JavaScript direkt aus anstatt als Link. false
pos int Beeinflusst die Reihenfolge der Ausgabe. -1
[return] void

asciitree

Erstellt für alle Seiten der Website einen textbasierten (=Ascii) Baum. Alle Parameter werden als assoziatives Array übergeben.

string asciitree([array options = {}])
route string Gibt den Baum ab der angegebenen Route aus. ””
showHidden bool Definiert ob versteckte Seiten angezeigt werden sollen. false
maxDepth int Definiert die maximale Tiefe der Verschachtelung. -1
class string Der CSS-Klassenname. sitemap
[return] string Der Baum der Website als Ascii-Text

bodyclass

Gibt CSS-Klassen zurück, die für das class-Attribut des body-Tags genutzt werden können.

string bodyclass()
[return] string Die CSS-Klassen für das body-Tag

breadcrumb

Gibt für die aktuelle Seite einen vollständigen Brotkümelpfad aus. Alle Parameter werden als assoziatives Array übergeben.

string breadcrumb([array options = {}])
delim string Der Trenner. ””
homeLink string Der Link zur Homepage null
reverse bool Ob der Pfad umgekehrt ausgegeben werden soll. false
[return] string Der generierte Brotkümelpfad

config

Gibt den Wert einer bestimmten Konfiguration-Einstellung aus.

string config(string name[, mixed default = null])
name int Der Name der Konfigurations-Einstellung.
default mixed Der Defaultwert, falls keine Konfiguration vorhanden. null
[return] mixed Die Konfigurations-Einstellung

content

Gibt den Inhalt für ein bestimmtes Segment aus.

string content([int segmentId = 0][, bool wrap = false])
segmentId int Der Name des Inhaltssegments. 0
wrap bool Umhüllt den Inhalt mit einem DIV-Tag. false
[return] string Der Inhalt für ein bestimmtes Segment

image

Gibt ein IMG-Tag aus.

string image(string src [, string width = ''][, string height = ''][, string alt = ''][, string class = ''])
src string Der relative Pfad zur Bilddatei.
width string Die Breite des Bildes. ””
height string Die Höhe des Bildes. ””
alt string Der ALT-Text des Bildes. ””
class string Das HTML-Attribut class. ””
[return] string Das IMG HTML-Tag

link

Gibt zu einer bestimmten Route einen HTML-Link mit dem Label und den Attributen aus.

string link(string route, string label [, array htmlAttributes = {}])
route string Die Route zu einer Seite.
label string Das Label.
htmlAttributes array Die HTML-Attribute als assoziatives Array.
[return] string Der Link zu einer Route

menu

Gibt ein Menü der Seiten der Website als verschachtelte HTML-Liste zurück. Alle Parameter werden als assoziatives Array übergeben.

string menu([array options = {}])
route string Gibt das Menü ab der angegebenen Route aus. null
showHidden bool Definiert ob versteckte Seiten angezeigt werden sollen. false
[return] string Das Menü als HTML-Liste

outputcss

Gibt die CSS-Assets für eine bestimmte Gruppe zurück.

string outputcss([string group])
group string Das gruppierte CSS. null
[return] string Die CSS-Assets

outputjs

Gibt die JavaScript-Assets für eine bestimmte Gruppe zurück.

string outputjs([string group])
group string Das gruppierte JavaScript. null
[return] string Die JavaScript-Assets

pagetitle

Gibt den Seitentitel der Website SEO-optimiert aus. Alle Parameter werden als assoziatives Array übergeben.

string pagetitle([array options = {}])
delim string Der Trenner. /
siteTitle string Der Titel der Website. null
rootTitle string Der Titel der Rootseite der Website. null
reverse bool Ob der Pfad umgekehrt ausgegeben werden soll. false
[return] string Der Seitentitel der Website

pager

Erstellt eine Paginierung mit Links zur vorherigen und nächsten Seite (im Seitenbaum). Alle Parameter sind optional und werden als benannte Parameter übergeben.

string pager([string limit = ""][, string template = "{prev}{next}"][, string linkClass = ""][, string prevPageLabel = ""][, string nextPageLabel = ""][, string prevPageIcon = ""][, string nextPageIcon = ""])
limit string Beschränkt die Anwendung auf einen bestimmten Bereich des Seitenbaums.
template string Das Template. {prev}{next}
linkClass string Die CSS-Klasse der Links.
prevPageLabel string Das Label des Links zur vorherigen Seite. Wenn leer wird der Seitentitel angezeigt.
nextPageLabel string Das Label des Links zur nächsten Seite. Wenn leer wird der Seitentitel angezeigt.
prevPageIcon string Das Icon des Links zur vorherigen Seite.
nextPageIcon string Das Icon des Links zur nächsten Seite.
[return] string Der generierte HTML-Code

redirect

Leitet zur internen Seite mit der entsprechenden Route weiter und sendet einen gültigen Statuscode.

string redirect(string route [, int status = 302])
route string Die Route zu einer Seite.
status int Der Statuscode. 302
[return] void

sitemap

Erstellt für alle Seiten der Website eine Sitemap basierend auf einer unsortierten HTML-Liste. Alle Parameter werden als assoziatives Array übergeben.

string sitemap([array options = {}])
route string Gibt die Sitemap ab der angegebenen Route aus. ””
showHidden bool Definiert ob versteckte Seiten angezeigt werden sollen. false
maxDepth int Definiert die maximale Tiefe der Verschachtelung. -1
class string Der CSS-Klassenname. sitemap
[return] string Die Sitemap der Website als HTML-Liste

url

Gibt zu einer bestimmten Route die URL aus.

string url(string route)
route string Die Route zu einer Seite.
[return] string Die URL zu einer Route.