Standard TagLibs :: Adventure PHP Framework (APF)

Standard TagLibs

Folgende TagLib-Tags stehen zur Verfügung. In nicht selbstschließenden Tags sind alle HTML- Tags und -Formatierungen erlaubt. Die Tags können mit den üblichen HTML-Attributen ausgestattet werden, sofern diese für die Ausgabe oder Funktion relevant sind.

Hinweis: Bitte beachten Sie, dass innerhalb von Tag-Definitionen ausschließlich Leerzeichen eingesetzt werden dürfen. Tabs oder Zeilenumbrüche werden nicht erkannt und es kommt u.U. zu Fehlern beim Auslesen der Tag-Definitionen!

1. Core

1.1. Addtaglib

TagLibs sind nur innerhalb eines Dokuments des Objektbaums gültig. Um eine selbst implementierte TagLib im aktuellen Dokument einbinden zu können wird folgender Tag verwendet. Dieser sollte möglichst am Anfang des Dokuments plaziert sein, da Tags erst nach erfolgreicher Einbindung einer TagLib geparst werden können.

APF-Template

<core:addtaglib namespace="" prefix="" class="" />

Beschreibung der Attribute:

namespace: Ein mit "::" getrennter Namespace-Pfad. (Zeichen: [A-Za-z0-9_-:])
prefix: XML-Prefix (Zeichen: [a-z])
class: XML-Klasse (Zeichen: [a-z])

Die vom Entwickler erzeugte TagLib-Klasse muss die Form "<prefix>_taglib_<class>" haben. Die innerhalb der Klasse zu implementierenden Methoden sind der API-Dokumentation zu entnehmen. In der Regel wird das Tag für die Einbindung der Form-TagLib verwendet. Eigene Taglibs machen vor allem dann Sinn, wenn eigene abgetrennte Bereiche einer Applikation mehrfach verwendbar gemacht werden wollen (z.B. Warenkorb).

1.2. Importdesign

Möchte der Template-Bauer an einer definierten Stelle ein weiteres Document einfügen, so kann der Tag

APF-Template

<core:importdesign namespace="" template="" [incparam=""] [context=""]/>

Beschreibung der Attribute:

namespace: Ein mit "::" getrennter Namespace-Pfad. (Zeichen: [A-Za-z0-9_-:])
template: Name eines Templates. (Zeichen: [A-Za-z0-9-_])
incparam: URL-Parameter der abgefragt wird, welches Template eingebunden werden soll.
context: Setzt den Context ab dem durch den Tag erzeugten APF-DOM-Knoten auf den angegebenen Context.

verwendet werden. Wird bei der Definition des Tags ein sog. pagepart-Template definiert, kann ein Template abhängig vom URL-Parameter eingebunden werden. Standard-Parameter ist "pagepart", dieser kann jedoch mit dem optionalen Attribut "incparam" angepasst werden. Beispiel für die Einbindung mit pagepart-Parameter:

APF-Template

<core:importdesign namespace="sites::testsite::pres::templates" template="[pagepart = test]" />
<core:importdesign namespace="sites::testsite::pres::templates" template="[cmsmodule = test]" \
 incparam="cmsmodule" />

Das eingebundene Template erbt automatisch die Eigenschaften des Vater-Objekts. Insbesondere Context und Sprache werden übertragen.

Das Attribut context sollte dann eingesetzt werden, wenn die Notwendigkeit besteht, ein Modul innerhalb einer Applikation mehrmals und mit unterschiedlichen Konfiguration einzusetzen. Dabei sollten die Module durch die Importdesign-Taglib oder eine abgeleitete Klasse eingebunden und mit dem gewünschten Context versort werden. Alle unterhalb des Knotens angelegten APF-DOM-Knoten werden dann mit dem in den Tag-Attributen gesetzten Context versorgt und können wie gewohnt auf die gewünschten Konfigurationen zugreifen.

1.3. Setproperty

Um eine Eigenschaft des aktuellen Documents im Template setzen zu können steht dem, Entwickler der "core:setproperty"-Tag zur Verfügung. Typischer Anwendungsfall ist es den Context oder die Sprache eines Documents mit diesem Text zu setzen um auf eine anderssprachige Seite zu wechseln.

APF-Template

<core:setproperty name="" value="" />

Eine Liste der Eigenschaften eines von der Klasse "Document" erbenden Klasse entnehmen Sie bitte der API-Dokumentation.

Um das Tag verwenden zu können muss die TagLib "core:setproperty" erst via

APF-Template

<core:addtaglib namespace="core::pagecontroller" prefix="core" class="setproperty" />

eingebunden werden.

Beschreibung der Attribute:

name: Name der zu befüllenden Eigenschaft. (Zeichen: [A-Za-z0-9_-])
value: Wert der Eigenschaft. (Zeichen: [A-Za-z0-9-_:.])

1.4. Setattribute

Der Tag "core:setattribute" verhält sich analog zu "core:setproperty", nur wird bei diesem der Wert eines Attributes des Dokuments gesetzt.

APF-Template

<core:setattribute name="" value="" />

Um das Tag verwenden zu können muss die TagLib "core:setattribute" erst via

APF-Template

<core:addtaglib namespace="core::pagecontroller" prefix="core" class="setattribute" />

eingebunden werden.

Beschreibung der Attribute:

name: Name des Attributes. (Zeichen: [A-Za-z0-9_-])
value: Wert des Attributes. (Zeichen: [A-Za-z0-9-_:.])

2. Html

2.1. Placeholder

Um in einem DocumentController Inhalte dynamisch füllen zu können gibt es den html:placeholder- Tag.

APF-Template

<html:placeholder name="" />

Beschreibung der Attribute:

name: Name des Platzhalters. Über den Namen kann auf das Element zugegriffen werden. (Zeichen: [A-Za-z0-9-_])

Um einen Platzhalter mit Inhalt zu füllen kann man in einem DocumentController folgendes einbauen:

PHP-Code

$this->setPlaceHolder('NameDesPlatzhalters','InhaltDesPlatzHalters');

2.2. Getstring:

Der Tag "html:getstring" dient dazu einen Konfigurations-String aus einer sprachabhängigen Konfigurations-Datei auszulesen und anzuzeigen. So können auf einfache Weise mehrsprachige Anwendungen aufgebaut werden.

APF-Template

<html:getstring namespace="" config="" entry="" />

Um das Tag verwenden zu können muss die TagLib "html:getstring" erst via

APF-Template

<core:addtaglib namespace="tools::html::taglib" prefix="html" class="getstring" />

eingebunden werden.

Beschreibung der Attribute:

namespace: Namespace der Konfigurationsdatei. (Zeichen: [A-Za-z0-9_-:])
config: Name der Konfigurationsdatei. (Zeichen: [A-Za-z0-9-_])
entry: Name des Konfigurations-Offsets. (Zeichen: [A-Za-z0-9-_.])

Die sprachabhängige Konfigurationsdatei muss jeweils eine Sektion pro Sprache (zweistelliger ISO-Länder-Code) und die verwendeten Konfigurationsschlüssel in den Sektionen enthalten sein. Soll der Tag

APF-Template

<html:getstring namespace="modules::mymodule" config="language" entry="title" />

zur Anzeige eines sprachabhängigen Titels in einem Template genutzt werden, muss die Konfigurationsdatei

Code

/config/modules/mymodule/{CONTEXT}/{ENVIRONMENT}_language.ini

mit dem Inhalt

APF-Konfiguration

[de]
title = "Mein Modul"

[en]
title = "My module"

gefüllt werden. Diese Beschreibung gilt ebenso für die Tags <form:getstring /> (Kapitel 2.4.19.) und <template:getstring /> (Kapitel 2.3.3.).

2.3. Template

2.3.1. Basis-Funktionen

Um weitere Elemente für die Ausgabe-Steuerung definieren zu können gibt es so genannte Templates. Diese können innerhalb eines DocumentControllers manipuliert und verarbeitet werden. In einem Template gibt es wiederum Platzhalter, die dynamisch gesetzt werden können.

APF-Template

<html:template name="">
  [<template:placeholder name="" />]
  [<template:addtaglib namespace="" prefix="" class="" />]
</html:template>

Beschreibung der Attribute:

name: Name des Templates bzw. des Platzhalters innerhalb des Templates. Über den Namen kann auf das Element zugegriffen werden. (Zeichen: [A-Za-z0-9-_])

Zugriff auf ein Template gewährt die private Methode "__getTemplate()" eines DocumentControllers. Mit Hilfe dieser Funktion kann eine Referenz auf ein Template-Objekt zurückgeliefert werden. Ein typischer Anwendungsfall sieht so aus:

Template:

APF-Template

<@controller namespace="" file="" class="" @>
<html:placeholder name="Content" />

<html:template name="MyTemplate">
  <template:placeholder name="MyPlaceHolder">
</html:template>

Controller:

PHP-Code

class myDocumentController extends baseController {
   function transformContent(){
      $Template__MyTemplate = &$this->__getTemplate('MyTemplate');
      $Template__MyTemplate->setPlaceHolder('MyPlaceHolder','MyContent');
      $this->setPlaceHolder('Content',$Template__MyTemplate->transformTemplate());
   }
}

Hier wird in der XML-Datei ein Document-Controller, ein HTML-Platzhalter und ein Template mit zugehörigem Platzhalter definiert. Im Controller kann man nun mittels der Methoden __getTemplate() eine Referenz auf das Template holen und mit setPlaceHolder() den Platzhalter im Template füllen. Anschließend wird das Template transformiert und die Ausgabe in den HTML-Platzhalter mittels setPlaceHolder() eingesetzt. Es ist möglich mehrere Templates auf einer Seite zu platzieren. Oft wird das für die Ausgabe von unterschiedlichen Meldungen bei unterschiedlichen Events eingesetzt.

2.3.2. Template-Erweiterungen:

Um die Funktionalitäten innerhalb eines Templates mit weiteren TagLibs erweitern zu können steht der Tag "<template:addtaglib />" zur Verfügung. Ähnlich dem "<core:addtaglib />"- Tag können hier innerhalb eines Templates weitere TagLibs hinzugefügt werden.

APF-Template

<template:addtaglib namespace="" prefix="" class="" />

Beschreibung der Attribute:

namespace: Ein mit "::" getrennter Namespace-Pfad. (Zeichen: [A-Za-z0-9_-:])
prefix: XML-Prefix (Zeichen: [a-z])
class: XML-Klasse (Zeichen: [a-z])

Ein Beispiel für die Verwendung des XML-Tags ist der TagLib-Tag <[html|template]:getstring /> zum Auslesen und Darstellen eines Strings aus einer Konfigurations-Datei. Siehe hierzu Kapitel 2.2.3. bzw. 2.4.

2.3.3. Getstring:

Der Tag "template:getstring" dient dazu einen Konfigurations-String aus einer sprachabhängigen Konfigurations-Datei auszulesen und anzuzeigen. So können auf einfache Weise mehrsprachige Anwendungen aufgebaut werden.

APF-Template

<template:getstring namespace="" config="" entry="" />

Um das Tag verwenden zu können muss die TagLib "template:getstring" erst via

APF-Template

<template:addtaglib namespace="tools::html::taglib" prefix="template" class="getstring" />

eingebunden werden.

Beschreibung der Attribute:

namespace: Namespace der Konfigurationsdatei. (Zeichen: [A-Za-z0-9_-:])
config: Name der Konfigurationsdatei. (Zeichen: [A-Za-z0-9-_])
entry: Name des Konfigurations-Offsets. (Zeichen: [A-Za-z0-9-_.])

2.4. Form

Die im Release mitgelieferten Formular-Taglibs können unter Formulare (ab Version 1.11) eingesehen werden und wurden aus Gründen der Übersichtlichkeit von dieser Seite entfernt.

Nutzen Sie noch die Formular-Taglibs des Release 1.10, so finden sie die vorhanden Formular-Taglibs unter Formular-Taglibs (bis Version 1.10). Bitte beachten Sie zum Einsatz der alten Taglibs mit dem neuen APF-Release das HOWTO im Wiki.

3. Document

3.1. createobject

Der Tag erzeugt aus einer Inhalts-Datei unter dem Ordner ./frontend/content/ einen weiteren Unter-Objektbaum. Die Inhalts-Dateien werden in der Form

Code

c_{LANGCODE}_{NAME}.html

erwartet, wobei

LANGCODE für ein zweizeichen Länderkürzel (de, en, it, es, ...) steht und
NAME der URL-Name ist.

APF-Template

<doc:createobject requestparam="" defaultvalue="" />

Beschreibung der Attribute:

requestparam: URL-Parameter, der angibt, welche Content-Datei gezogen wird. (Zeichen: [A-Za-z0-9])
defaultvalue: Default-Wert für den Parameter requestparam.

Um die TagLib verwenden zu können muss diese mit einem

APF-Template

<core:addtaglib namespace="tools::html::taglib" prefix="doc" class="createobject" />

in der Template-Datei eingebunden werden.

Wird keine zum zu requestparam passende Datei im Ordner gefunden, erwartet der Tag eine Datei mit dem Namen

Code

c_{LANGCODE}_404.htm

um anzeigen zu können, dass die gewünschte Seite nicht verfügbar ist. Ist auch diese Datei nicht verfügbar kommt es zu einem PHP-Fehler.

4. Document-Controller

Um einem Dokument einen Controller zu deklarieren muss folgender Tag am Anfang des Templates platziert werden:

APF-Template

<@controller namespace="" file="" class="" @>

Beschreibung der Attribute:

namespace: Namespace-Pfad zum Controller. (Zeichen: [A-Za-z0-9:])
file: Datei-Namen in dem der Controller residiert. (Zeichen: [A-Za-z0-9_])
class: Klassen-Namen des Controllers. (Zeichen: [A-Za-z0-9_])

Die Implementierung des DocumentControllers muss immer vom baseController ableiten. Dieser ist bereits im PageController definiert und stellt grundlegende Methode für das Handling von DOM- Objekten bereit. Beispiel hierfür ist die __getForm()-Methode, die eine Referenz auf ein Formular zurückgibt.

5. FrontController

Mit dem Release 1.4-18.11.2007 wurde der Tag "<fcon:importdesign />" eingefügt. Dieser unterstützt bei der Implementierung von FrontController-basierten Applikationen und bindet Views auf Grund von Model-Informationen im Sinne des MVC-Pattern ein. Hierzu muss eine eigene Model-Klasse für die aktuelle Applikation oder das eingebundene Modul erstellt werden, aus dem die Informationen für die Einbindung des Views bezogen werden können. Die Steuerung der View-Einbindung wird typischerweise durch eigene FrontController-Actions geregelt, die im Modus "prepagecreate" (siehe FrontController, Kapitel 1.6) ausgeführt wird. Diese kann in der URL enthaltene Parameter an das Model-Objekt weitergeben.

APF-Template

<fcon:importdesign
      templatenamespace=""
      modelnamespace=""
      modelfile=""
      modelclass=""
      modelparam=""
      [sessionsingleton=""]
  />

Beschreibung der Attribute:

templatenamespace: Namespace zum Template-Ordner. (Zeichen:: [A-Za-z0-9:])
modelnamespace: Namespace zur Model Klasse. (Zeichen: [A-Za-z0-9:])
modelfile: Name der Datei, in der sich die Model-Klasse befindet. (Zeichen: [A-Za-z0-9_])
modelclass: Name der Model-Klasse. (Zeichen: [A-Za-z0-9_])
modelparam: Model-Parameter, der für die Einbindung des Templates verwendet werden soll. (Zeichen: [A-Za-z0-9_])
sessionsingleton: Definiert, ob das Model-Objekt im SINGLETON oder SESSIONSINGLETON Modus vom ServiceManager bezogen werden soll. Ist das Attribut nicht vorhanden oder enthält es einen anderen Wert als true, so wird der SINGLETON Modus verwendet. (Werte: true|false)

Kommentare

Bitte geben Sie Ihren Kommentar hier ein. Füllen Sie alle mit * gekennzeichneten Felder vollständig und korrekt aus. Um zum Artikel zurückzukehren klicken sie bitte hier. Zur Formatierung des Textes können folgende BBCode-ähnliche die Zeichen verwendet werden:

[b]..[/b]: fett
[i]..[/i]: kursiv
[u]..[/u]: unterstrichen

Hinweis: Formatierungszeichen in Name und E-Mail-Adresse werden nicht akzeptiert.

Standard TagLibs

Kommentare

QUICKNAVI