Previous Next

Erstellen von eigenem Form Markup durch Zend_Form_Decorator

Die Darstellung eines Form Objektes ist komplett optional -- Zend_Form's render() Methoden müssen nicht einmal verwendet werden. Wenn es trotzdem so gemacht wird, dann werden Dekoratoren verwendet um die verschiedenen Form Objekte darzustellen.

Eine Vielzahl an Dekoratoren kann jedem Teil angefügt werden (Elemente, Display Gruppen, Sub Forms, oder das Form Objekt selbst); trotzdem kann nur ein Dekorator eines bestimmten Typs jedem Teil engefügt werden. Dekoratoren werden in der Reihenfolge aufgerufen in der Sie registriert werden. Abhängig vom Dekorator, kann dieser den Inhalt ersetzen der Ihm übergeben wurde, oder Inhalt anhängen oder voranstellen.

Der Objektstatus wird durch Konfigurations Optionen gesetzt die dem Konstruktor oder der setOptions() Methode des Dekorators übergeben werden. Wenn Dekoratoren, über addDecorator() des Teils oder ähnliche Methoden, erstellt werden können der Methode Optionen als Argument übergeben werden. Diese können verwendet werden um eine Platzierung zu spezifizieren, einen Separator der zwischen übergebenem Inhalt und neu erstelltem Inhalt verwendet wird, oder welche Option der Dekorator auch immer unterstützt.

Bevor jede render() Methode der Dekoratoren aufgerufen wird, wird das aktuelle Teil im Dekorator mit setElement() gesetzt, was dem Dekorator zeigt welches Teil dargestellt werden soll. Das erlaubt es Dekoratoren zu erstellen die nur spezielle Abschnitte des Teils darstellen -- wie das Label, den Wert, Fehlermeldungen, usw. Durch die Verbindung von verschiedenen Dekoratoren die ein spezielles Segment des Elements darstellen kann ein komplexes Markup gebaut werden das das komplette Teil repräsentiert.

Operationen

Um einen Dekorator zu konfigurieren, kann ein Array von Optionen, oder ein Zend_Config Objekt an dessen Konstruktor übergeben werden, ein Array an setOptions(), oder ein Zend_Config Objekt an setConfig().

Die Standard Optionen beinhalten:

  • placement: Die Platzierung kann entweder 'append' oder 'prepend' sein (unabhängig von der Schreibweise), und definiert ob der Inhalt der render() übergeben wird, angehängt oder vorangestellt wird. Im Fall das ein Dekorator den Inhalt ersetzt wird diese Einstellung ignoriert. Der Standardwert ist anhängen.

  • separator: Der Separator wird zwischen dem Inhalt der an render() übergeben wird und durch den Dekorator neu erstelltem Inhalt verwendet, oder zwischen Teilen die durch den Dekorator dargestellt werden (z.B. FormElements verwenden Separatoren zwischen jedem dargestellten Teil). Im Fall das ein Dekoratpr den Inhalt ersetzt, wird diese Einstellung ignoriert. Der Standardwert ist PHP_EOL.

Das Dekorator Interface spezifiziert Methoden für die Interaktion mit Optionen. Diese beinhalten:

  • setOption($key, $value): setzt eine einzelne Option.

  • getOption($key): eine einzelne Optionswert erhalten.

  • getOptions(): alle Optionen erhalten.

  • removeOption($key): eine einzelne Option entfernen.

  • clearOptions(): alle Optionen entfernen.

Dekoratore sollen mit den verschiedenen Zend_Form Klassentypen interagieren: Zend_Form, Zend_Form_Element, Zend_Form_DisplayGroup, und allen von Ihnen abgeleiteten Klassen. Die Methode setElement() erlaubt es das Objekt des Dekorators mit den aktuell gearbeitet wird, zu setzen und getElement() wird verwendet um es zu empfangen.

Die render() Methode jeden Dekorators akzeptiert einen String $content. Wenn der erste Dekorator aufgerufen wird, ist dieser String typischerweise leer, wärend er bei nachfolgenden Aufrufen bekannt sein wird. Basierend auf dem Typ des Dekorators und den Ihm übergebenen Optionen, wird der Dekorator entweder diesen String ersetzen, den String voranstellen oder den String anfügen; ein optionaler Separator wird in den späteren zwei Siturationen verwendet.

Standard Dekoratore

Zend_Form wird mit vielen Standard Dekoratoren ausgeliefert; siehe das Kapitel über Standard Dekorator für Details.

Eigene Dekoratore

Wenn man der Meinung ist das die Notwendigkeiten der Darstellung sehr komplex sind oder starke Anpassungen benötigt, sollte man an die Erstellung eines eigenen Dekorators überlegen.

Dekoratore implementieren nur Zend_Decorator_Interface. Das Interface spezifiziert folgendes:

interface Zend_Decorator_Interface
{
    public function __construct($options = null);
    public function setElement($element);
    public function getElement();
    public function setOptions(array $options);
    public function setConfig(Zend_Config $config);
    public function setOption($key, $value);
    public function getOption($key);
    public function getOptions();
    public function removeOption($key);
    public function clearOptions();
    public function render($content);
}

Um das einfacher zu machen, kann man einfach Zend_Decorator_Abstract erweitern, welches alle Methoden außer render() implementiert.

Als Beispiel nehmen wir an das wir die Anzahl an verwendeten Dekoratoren verringern will, und einen "gemeinsamen" Dekorator erstellt der die Darstellung von Label, Element, jegliche Fehlermeldung, und Beschreibung in einem HTML div übernimmt. So ein 'Gemeinsamer' Dekorator kann wie folgt erstellt werden:

class My_Decorator_Composite extends Zend_Form_Decorator_Abstract
{
    public function buildLabel()
    {
        $element = $this->getElement();
        $label = $element->getLabel();
        if ($translator = $element->getTranslator()) {
            $label = $translator->translate($label);
        }
        if ($element->isRequired()) {
            $label .= '*';
        }
        $label .= ':';
        return $element->getView()
                       ->formLabel($element->getName(), $label);
    }

    public function buildInput()
    {
        $element = $this->getElement();
        $helper  = $element->helper;
        return $element->getView()->$helper(
            $element->getName(),
            $element->getValue(),
            $element->getAttribs(),
            $element->options
        );
    }

    public function buildErrors()
    {
        $element  = $this->getElement();
        $messages = $element->getMessages();
        if (empty($messages)) {
            return '';
        }
        return '
' . $element->getView()->formErrors($messages) . '
'; } public function buildDescription() { $element = $this->getElement(); $desc = $element->getDescription(); if (empty($desc)) { return ''; } return '
' . $desc . '
'; } public function render($content) { $element = $this->getElement(); if (!$element instanceof Zend_Form_Element) { return $content; } if (null === $element->getView()) { return $content; } $separator = $this->getSeparator(); $placement = $this->getPlacement(); $label = $this->buildLabel(); $input = $this->buildInput(); $errors = $this->buildErrors(); $desc = $this->buildDescription(); $output = '
' . $label . $input . $errors . $desc . '
' switch ($placement) { case (self::PREPEND): return $output . $separator . $content; case (self::APPEND): default: return $content . $separator . $output; } } }

Das kann das in den Dekorator Pfad platziert werden:

// für ein Element:
$element->addPrefixPath('My_Decorator',
                        'My/Decorator/',
                        'decorator');

// für alle Elemente:
$form->addElementPrefixPath('My_Decorator',
                            'My/Decorator/',
                            'decorator');

Man kann dann diesen Dekorator als 'Gemeinsam' spezifizieren und diesen an ein Element anfügen:

// Überschreibe existierende Dekoratoren mit diesem einzelnen:
$element->setDecorators(array('Composite'));

Wärend dieses Beispiel zeigt wie ein Dekorator erstellt werden kann der komplexe Ausgaben von verschiedenen Element-Eigenschaften darstellt können auch Dekoratore erstellt werden die einzelne Aspekte eines Elements handhaben; die 'Decorator' und 'Label' Dekoratore sind exzellente Beispiele dieser Praxis. Das erlaubt es Dekotatore zu mischen und zu anzupassen um komplexe Ausgaben zu erhalten -- und auch die Überladung von einzelnen Aspekten der Dekoration für die Anpassung an eigene Bedürfnisse.

Wenn man ,zum Beispiel, eine einfache Anzeige benötigt, das ein Fehler aufgetreten ist wären ein Element überprüft wurde, aber nicht jede der individuellen Validator Fehlermeldungen angezeigt werden soll, kann ein eigener 'Errors' Dekorator erstellt werden:

class My_Decorator_Errors
{
    public function render($content = '')
    {
        $output = '
Der angegebene Wert war ungültig; bitte nochmals versuchen
'; $placement = $this->getPlacement(); $separator = $this->getSeparator(); switch ($placement) { case 'PREPEND': return $output . $separator . $content; case 'APPEND': default: return $content . $separator . $output; } } }

In diesem speziellen Beispiel, weil das letzte Segment, 'Errors', des Dekorators auf Zend_Form_Decorator_Errors passt wird er statt diesem Dekorator dargestellt -- was bedeutet das kein Dekorator verändert werden muß um die Ausgabe anzupassen. Durch die Benennung des Dekorators nach dem bestehenden Standard Dekorator, kann die Dekoration verändert werden ohne das der Dekorator des Elements verändert werden muß.

Darstellung individueller Dekoratore

Da Dekoratore verschiedene Metadaten, eines Elements oder Formulars das Sie darstellen, ansprechen, ist es oft nützlich zu bestimmten Zeiten nur einen individuellen Dekorator darzustellen. Glücklicherweise ist dieses Feature über Methodenüberladung in jeder der grundsätzlichen Klassen der Formulartypen möglich (Formulare, Unterformulare, Anzeigegruppen, Elemente).

Um das zu tun muß einfach render[DecoratorName]() aufgerufen werden, wobei "[DecoratorName]" der "Kurzname" des eigenen Dekorators ist; optional kann Inhalt eingefügt werden der dargestellt werden soll. Zum Beispiel:

// Nur den Label Dekorator des Elements darstellen:
echo $element->renderLabel();

//Nur die Anzeigegruppe Fieldset mit Inhalt darstellen:
echo $group->renderFieldset('fieldset content');

// Nur das HTML Tag des Forumars mit Inhalt darstellen:
echo $form->renderHtmlTag('wrap this content');

Wenn der Dekorator nicht existiert, wird eine Exception geworfen.

Das kann speziell dann nützlich sein wenn ein Formular mit dem ViewScript Dekorator dargestellt wird; jedes Element kann seine angehängten Dekoratore verwenden um Inhalte darzustellen, aber mit fein-abgestimmter Kontrolle.

Previous Next
Introduction to Zend Framework
Übersicht
Installation
Zend_Acl
Einführung
Verfeinern der Zugriffskontrolle
Fortgeschrittene Verwendung
Zend_Amf
Einführung
Zend_Amf_Server
Zend_Auth
Einführung
Datenbanktabellen Authentifizierung
Digest Authentication
HTTP Authentication Adapter
LDAP Authentifizierung
Open ID Authentifikation
Zend_Cache
Einführung
Die Theorie des Cachens
Zend_Cache Frontends
Zend_Cache Backends
Zend_Captcha
Einführung
Captcha Anwendung
Captcha Adapter
Zend_Config
Einleitung
Theory of Operation
Zend_Config_Ini
Zend_Config_Xml
Zend_Config_Writer
Zend_Config_Writer
Zend_Console_Getopt
Einführung in Getopt
Definieren von Getopt Regeln
Holen von Optionen und Argumenten
Konfigurieren von Zend_Console_Getopt
Zend_Controller
Zend_Controller Schnellstart
Zend_Controller Grundlagen
Der Front Controller
Das Request Objekt
Der Standard Router
Der Dispatcher
Action Kontroller
Action Helfer
Das Response Objekt
Plugins
Eine konventionelle modulare Verzeichnis Struktur verwenden
MVC Ausnahmen
Migration von vorhergehenden Versionen
Zend_Currency
Einführung in Zend_Currency
Arbeiten mit Währungen
Migration von vorhergehenden Versionen
Zend_Date
Einführung
Theorie der Arbeitsweise
Basis Methoden
Zend_Date API Übersicht
Erstellen von Datumswerten
Konstanten für generelle Datums Funktionen
Funktionierende Beispiele
Zend_Db
Zend_Db_Adapter
Zend_Db_Statement
Zend_Db_Profiler
Zend_Db_Select
Zend_Db_Table
Zend_Db_Table_Row
Zend_Db_Table_Rowset
Zend_Db_Table Relationships
Zend_Debug
Variablen ausgeben
Zend_Dojo
Einführung
Zend_Dojo_Data: dojo.data Envelopes
Dojo View Helfer
Dojo Form Elemente und Dekoratore
Zend_Dom
Einführung
Zend_Dom_Query
Zend_Exception
Verwenden von Ausnahmen
Zend_Feed
Einführung
Feeds importieren
Feeds von Websites abrufen
Einen RSS Feed konsumieren
Einen Atom Feed konsumieren
Einen einzelnen Atom Eintrag konsumieren
Verändern der Feed- und Eintragsstruktur
Eigene Klassen für Feeds und Einträge
Zend_File
Zend_File_Transfer
Prüfungen für Zend_File_Transfer
Filter für Zend_File_Transfer
Migration von vorhergehenden Versionen
Zend_Filter
Einführung
Standard Filter Klassen
Filter Ketten
Filter schreiben
Zend_Filter_Input
Zend_Filter_Inflector
Zend_Form
Zend_Form
Schnellstart mit Zend_Form
Erstellen von Form Elementen mit Hilfe von Zend_Form_Element
Erstellen von Form durch Verwendung von Zend_Form
Erstellen von eigenem Form Markup durch Zend_Form_Decorator
Standard Form Elemente die mit dem With Zend Framework ausgeliefert werden
Standard Form Dekoratore die mit dem Zend Framework ausgeliefert werden
Internationalisierung von Zend_Form
Fortgeschrittene Verwendung von Zend_Form
Zend_Gdata
Einführung zu Gdata
Authentifizierung mit AuthSub
Die Buchsuche Daten API verwenden
Authentifizieren mit ClientLogin
Google Kalender verwenden
Verwenden der Google Dokumente Listen Daten API
Using Google Health
Google Tabellenkalkulation verwenden
Google Apps Provisionierung verwenden
Google Base verwenden
Picasa Web Alben verwenden
Verwenden der YouTube Daten API
Gdata Ausnahmen auffangen
Zend_Http
Zend_Http_Client - Einführung
Zend_Http_Client - Fortgeschrittende Nutzung
Zend_Http_Client - Verbindungsadapter
Zend_Http_Cookie und Zend_Http_CookieJar
Zend_Http_Response
Zend_InfoCard
Einführung
Zend_Json
Einführung
Grundlegende Verwendung
JSON Objects
XML zu JSON Konvertierung
Zend_Json_Server - JSON-RPC server
Zend_Layout
Einführung
Zend_Layout Schnellstart
Zend_Layout Konfigurations Optionen
Erweiterte Verwendung von Zend_Layout
Zend_Ldap
Einleitung
Zend_Loader
Dynamisches Laden von Dateien und Klassen
Plugins laden
Zend_Locale
Einführung
Zend_Locale verwenden
Normalisierung und Lokalisierung
Arbeiten mit Daten und Zeiten
Unterstützte Gebietsschemata
Migrieren von vorhergehenden Versionen
Zend_Log
Übersicht
Writer
Formatter
Filter
Zend_Mail
Einführung
Versand über SMTP
Versand von mehreren E-Mails über eine SMTP Verbindung
Verwendung von unterschiedlichen Versandwegen
HTML E-Mail
Anhänge
Empfänger hinzufügen
Die MIME Abgrenzung kontrollieren
Zusätzliche Kopfzeilen
Zeichensätze
Kodierung
SMTP Authentifizierung
SMTP Übertragungen sichern
Lesen von Mail Nachrichten
Zend_Measure
Einführung
Erstellung einer Maßeinheit
Ausgabe von Maßeinheiten
Manipulation von Maßeinheiten
Arten von Maßeinheiten
Zend_Memory
Übersicht
Memory Manager
Memory Objekte
Zend_Mime
Zend_Mime
Zend_Mime_Message
Zend_Mime_Part
Zend_OpenId
Einführung
Zend_OpenId_Consumer Grundlagen
Zend_OpenId_Provider
Zend_Paginator
Einführung
Verwendung
Konfiguration
Advanced usage
Zend_Pdf
Einführung
Erstellen und Laden von PDF Dokumenten
Änderungen von PDF Dokumenten speichern
Dokument Seiten
Zeichnen
Dokument Informationen und Metadaten
Anwendungsbeispiel für die Zend_Pdf Komponente
Zend_ProgressBar
Zend_ProgressBar
Zend_Registry
Die Registry verwenden
Zend_Rest
Einführung
Zend_Rest_Client
Zend_Rest_Server
Zend_Search_Lucene
Überblick
Indexerstellung
Einen Index durchsuchen
Abfragesprache
Abfrage Erzeugungs API
Zeichensätze
Erweiterbarkeit
Zusammenarbeit Mit Java Lucene
Erweitert
Die besten Anwendungen
Zend_Server
Einführung
Zend_Server_Reflection
Zend_Service
Einführung
Zend_Service_Akismet
Zend_Service_Amazon
Zend_Service_Audioscrobbler
Zend_Service_Delicious
Zend_Service_Flickr
Zend_Service_Nirvanix
Zend_Service_ReCaptcha
Zend_Service_Simpy
Einführung
Zend_Service_StrikeIron
Zend_Service_StrikeIron: Mitgelieferte Services
Zend_Service_StrikeIron: Erweiterte Verwendung
Zend_Service_Technorati
Zend_Service_Twitter
Zend_Service_Yahoo
Zend_Session
Einführung
Grundsätzliche Verwendung
Fortgeschrittene Benutzung
Globales Session Management
Zend_Session_SaveHandler_DbTable
Zend_Soap
Zend_Soap_Server
Zend_Soap_Client
WSDL Zugriffsmethoden
AutoDiscovery
Zend_Test
Einführung
Zend_Test_PHPUnit
Zend_Text
Zend_Text_Figlet
Zend_Text_Table
Zend_TimeSync
Einführung
Arbeiten mit Zend_TimeSync
Zend_Translate
Einführung
Adapter für Zend_Translate
Benutzen von Übersetzungs Adaptoren
Migration von vorhergehenden Versionen
Zend_Uri
Zend_Uri
Zend_Validate
Einführung
Standard Prüfklassen
Kettenprüfungen
Schreiben von Prüfern
Zend_Version
Auslesen der Version des Zend Frameworks
Zend_View
Einführung
Controller Skripte
View Scripte
View Helfer
Zend_View_Abstract
Zend_Wildfire
Zend_Wildfire
Zend_XmlRpc
Einführung
Zend_XmlRpc_Client
Zend_XmlRpc_Server
Zend Framework Voraussetzungen
PHP Version
PHP Erweiterungen
Zend Framework Komponenten
Zend Framework Abhängigkeiten
Zend Framework Coding Standard für PHP
Übersicht
PHP Dateiformatierung
Namens Konventionen
Code Stil
Zend Framework Performance Guide
Einführung
Laden von Klassen
Internationalisierung (I18n) und Lokalisierung (L10n)
Darstellen der View
Urheberrecht Informationen