-
Schneller Einstieg
-
Grundlagen
-
Hilfsklassen
- Benchmark Klasse
- Cache Klasse
- Captcha Klasse
- cURL Klasse
- Database Klasse
- Date Klasse
- Errors Klasse
- FileSystem Klasse
- FTP Klasse
- Images Klasse
- Language Klasse
- Logger Klasse
- Number Klasse
- PayPal Klasse
- PHPMailer Klasse
- Plugins Klasse
- RestClient Klasse
- Security Klasse
- Template Klasse
- Text Klasse
- URL Klasse
- XML Klasse
- ZIP Klasse
Template Klasse
In den folgenden Abschnitten werden die einzelnen Methoden der Klasse erklärt.
setSkin
public void setSkin ( string $skin)
Setzt die aktuellen Skin für den Template Pfad. Standardmäßig ist der Skin welcome von webpackages gesetzt. Das heißt die Templates werden in der Ordnerstruktur package/views/welcome/ gesucht.
Parameterliste
Der Skin der zum Aufruf definiert wird. Dieser Wert wird automatisch gesetzt, wenn die Konstante TEMPLATE_DEFAULT_SKIN gefüllt ist.
setHeaderFile
public void setHeaderFile ( string $header)
In webpackages baut sich eine Seite durch 3 Template Dateien auf. Die header dann die dynamische Template Datei und zum schluss die footer Template Datei. Alle drei Templates ergeben die Seite die im Browser dargestellt wird. Hier wird die Standard header Template Datei festgelegt. Dabei muss nur der Name des Templates (mit Dateiendung) angegeben werden.
Parameterliste
header
Der Name des Header Templates
setFooterFile
public void setFooterFile ( string $footer)
In webpackages baut sich eine Seite durch 3 Template Dateien auf. Die header dann die dynamische Template Datei und zum schluss die footer Template Datei. Alle drei Templates ergeben die Seite die im Browser dargestellt wird. Hier wird die Standard footer Template Datei festgelegt. Dabei muss nur der Name des Templates (mit Dateiendung) angegeben werden.
Parameterliste
footer
Der Name des Footer Templates
setTemplateDir
public void setTemplateDir ( string $dir)
Der absolute Pfad zum Template Verzeichnis im webpackages Framework. Diese Methode wird automatisch aufgerufen, wenn die Konstante TEMPLATE_DIR gefüllt ist. Dabei darf man nur bis zum Skin gehen, nicht weiter.
Parameterliste
dir
Der absolute Pfad zum Template Verzeichnis. Nicht bis zum Skin.
setData
public void setData ( array $datas)
Ein assoziatives Array an Daten die in PHP Variablen umgewandelt werden und somit im Template zur Verfügung stehen. Somit kann man erzeugte Werte vom Model und Controller an die View (Templates) übermitteln.
Parameterliste
datas
Ein assoziatives Array mit key als PHP Variabeln Namen und value als Inhalt der Variabel.
setSingleData (ab v2.5.0)
public void setSingleData ( string $key, string $value)
Sollten Sie nur einen $key und $value Wert einfügen wollen, können Sie die setSingleData Method verwenden.
Parameterliste
key
Der Schlüsselbegriff, unter dem man die Variable im Template wiederfindet.
value
Der Wert oder Inhalt des Schlüssel oder der Variable im Template.
getTemplatePath
public string getTemplatePath ( )
Gibt den absoluten Pfad zum aktuellen Template Verzeichnis zurück.
displayPlugin
public void displayPlugin(string $template, bool $cacheActive = false, int $cacheExpiresTime = 0)
Kann genutzt werden um Plugin Templates darzustellen. Da die normale Methode display nur im aktuellen Template Verzeichnis nach dem richtigen Template schaut. Kann man hier einen absoluten Pfad zum Template angeben um es darzustellen.
Parameterliste
template
Der absolute Pfad zum Template dar dargestellt werden soll.
cacheActive
Ob das Template gecacht werden soll. Somit wird der PHP Inhalt im Template nicht immer erneut bei jedem Aufruf geparst.
cacheExpiresTimes
Die Dauer die das Template gecacht werden soll, bevor es erneut geparst wird.
display
public void display(string $template, string $header = null, string $footer = null, bool $cacheActive = false, int $cacheExpiresTime = 0)
Stellt ein Template aus dem aktuellen Template Verzeichnis dar.
Parameterliste
template
Der relative Pfad (ausgehend vom Template Verzeichnis) zum aufzurufenden Template.
header
Der Header der über dem Template dargestellt werden soll. Wenn null angegeben, dann wird der Standard Header genommen.
footer
Der Footer der unterhalb des Templates dargestellt werden soll. Wenn null angegeben, dann wird der Standard Footer genommen.
cacheActive
Ob das Template gecacht werden soll. Somit wird der PHP Inhalt im Template nicht immer erneut bei jedem Aufruf geparst.
cacheExpiresTimes
Die Dauer die das Template gecacht werden soll, bevor es erneut geparst wird.
load_template_file
public string load_template_file(string $file, string $type, string $dir = '', bool $minify = true)
Lädt eine Template benötigte Datei. Zum Beispiel eine JavaScript, CSS oder einfach nur eine Bilddatei. Dabei wird der Inhalt auch Minimiert und gecacht sowie Optimiert dargestellt.
Parameterliste
file
Der relative Dateiname zum Template Verzeichnis mit Dateiendung.
type
Um was für einen Dateitypen es sich dabei handelt. Erlaubt sind css, js und img.
dir
Das Verzeichnis in dem nach der Datei gesucht werden soll. Liegt also zum Beispiel das Bild im Templateverzeichnis im "img" Ordner, muss man hier "img" angeben. Dabei ist zu beachten das man keine Verzeichnisse zurückspringen kann.
minify
Erlaubt es bei Dateitypen mit js oder code den Code zu Optimieren. Leerräume, Kommentare und Anpassungen für die besser Lesbarkeit des Codes werden zu Optimierungszwecken entfernt.