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, Anzeigegruppen, Unterformulare, 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 Konfigurationsoptionen gesetzt die dem Konstruktor oder der setOptions() Methode des Dekorators übergeben werden. Wenn Dekoratoren, über addDecorator() 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 festzulegen, der zwischen übergebenem Inhalt und neu erstelltem Inhalt verwendet wird, oder welche Option der Dekorator sonst noch unterstützt.

Bevor jede render() Methode der Dekoratoren aufgerufen wird, wird das aktuelle Element im Dekorator mit setElement() gesetzt, was dem Dekorator zeigt welches Element dargestellt werden soll. Das erlaubt es Dekoratoren zu erstellen, die nur spezielle Abschnitte eines Elements 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 Element 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 (append).

  • 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 Element). Im Fall das ein Dekorator 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): Einen einzelnen Optionswert erhalten.

  • getOptions(): Alle Optionen erhalten.

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

  • clearOptions(): Alle Optionen entfernen.

Dekoratoren 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 jedes 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, voranstellen oder anfügen; ein optionaler Separator wird in den späteren zwei Situationen verwendet.

Standard Dekoratoren

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

Eigene Dekoratoren

Wenn man der Meinung ist, dass die Notwendigkeiten der Darstellung sehr komplex sind, oder starke Anpassungen benötigt, sollte man sich überlegen einen eigenen Dekorator zu erstellen.

Dekoratoren implementieren nur Zend_Form_Decorator_Interface. Das Interface spezifiziert folgendes:

interface Zend_Form_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 es sich einfacher zu machen, kann man Zend_Form_Decorator_Abstract erweitern, welches alle Methoden ausser render() implementiert.

Als Beispiel nehmen wir an, dass wir die Anzahl an verwendeten Dekoratoren verringern wollen, und einen "gemeinsamen" Dekorator erstellen der die Darstellung von Label, Element, jeglicher Fehlermeldungen, 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; } } }

Danach kannst du ihn in den Dekoratoren Pfad platzieren:

// 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ährend dieses Beispiel zeigt, wie ein Dekorator erstellt werden kann, der komplexe Ausgaben von verschiedenen Element-Eigenschaften darstellt, können auch Dekoratoren erstellt werden die einzelne Aspekte eines Elements handhaben; die 'Decorator' und 'Label' Dekoratoren sind exzellente Beispiele dieser Praxis. Das erlaubt es Dekotatoren zu mischen und 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, welche die, während der Validierung aufgetretenen, Fehlermeldungen ignoriert und dafür eine eigene Fehlermeldung anzeigt, kann man sich einen eigenen 'Errors' Dekorator erstellen:

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, dass 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, dass der Dekorator des Elements verändert werden muss.

Darstellung individueller Dekoratoren

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

Um das zu tun muss 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 Dekoratoren 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_Application
Einführung
Zend_Application Quick Start
Theorie der Funktionsweise
Beispiele
Kern Funktionalität
Vorhandene Ressource Plugins
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_CodeGenerator
Einführung
Zend_CodeGenerator Beispiele
Zend_CodeGenerator Referenz
Zend_Config
Einleitung
Theory of Operation
Zend_Config_Ini
Zend_Config_Xml
Zend_Config_Writer
Zend_Config_Writer
Zend_Console_Getopt
Einführung
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 Controller
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_Db_Table_Definition
Zend_Debug
Variablen ausgeben
Zend_Dojo
Einführung
Zend_Dojo_Data: dojo.data Envelopes
Dojo View Helfer
Formular Elemente und Dekoratore für Dojo
Zend_Dojo build layer support
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_Feed_Reader
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
Migration von vorhergehenden Versionen
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 Formular Dekoratoren die mit dem Zend Framework ausgeliefert werden
Internationalisierung von Zend_Form
Fortgeschrittene Verwendung von Zend_Form
Zend_Gdata
Einführung
Authentifizierung mit AuthSub
Die Buchsuche Daten API verwenden
Authentifizieren mit ClientLogin
Google Kalender verwenden
Verwenden der Google Dokumente Listen Daten API
Verwenden von 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
Einführung
Zend_Http_Client - Fortgeschrittende Nutzung
Zend_Http_Client - Verbindungsadapter
Migration von vorhergehenden Versionen
Zend_Http_Cookie und Zend_Http_CookieJar
Zend_Http_Response
Zend_InfoCard
Einführung
Zend_Json
Einführung
Grundlegende Verwendung
Fortgeschrittene Verwendung von Zend_Json
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
Einführung
API Übersicht
Usage Scenarios
Tools
Objektorientierter Zugriff auf den LDAP Baum durch Verwendung von Zend_Ldap_Node
Informationen vom LDAP Server erhalten
Serialisieren von LDAP Daten von und zu LDIF
Zend_Loader
Dynamisches Laden von Dateien und Klassen
Der Autoloader
Ressource Autoloader
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_Navigation
Einführung
Seiten
Container
Migration von vorhergehenden Versionen
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 an PDF Dokumenten speichern
Arbeiten mit Seiten
Zeichnen
Interactive Features
Dokument Informationen und Metadaten
Anwendungsbeispiel für die Zend_Pdf Komponente
Zend_ProgressBar
Zend_ProgressBar
Zend_Queue
Einführung
Beispiel der Verwendung
Framework
Adapter
Anpassen von Zend_Queue
Stomp
Zend_Reflection
Einführung
Zend_Reflection Beispiele
Zend_Reflection Referenz
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_Amazon_Ec2
Zend_Service_Amazon_Ec2: Instanzen
Zend_Service_Amazon_Ec2: Windows Instanzen
Zend_Service_Amazon_Ec2: Reservierte Instanzen
Zend_Service_Amazon_Ec2: CloudWatch Monitoring
Zend_Service_Amazon_Ec2: Amazon Maschinen Images (AMI)
Zend_Service_Amazon_Ec2: Elastischer Block Speicher (EBS)
Zend_Service_Amazon_Ec2: Elastische IP Adressen
Zend_Service_Amazon_Ec2: Schlüsselpaare
Zend_Service_Amazon_Ec2: Regionen und Availability Zones
Zend_Service_Amazon_Ec2: Sicherheitsgruppen
Zend_Service_Amazon_S3
Zend_Service_Amazon_Sqs
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_Tag
Einführung
Zend_Tag_Cloud
Zend_Test
Einführung
Zend_Test_PHPUnit
Zend_Test_PHPUnit_Db
Zend_Text
Zend_Text_Figlet
Zend_Text_Table
Zend_TimeSync
Einführung
Arbeiten mit Zend_TimeSync
Zend_Tool_Framework
Einführung
Verwenden des CLI Tools
Architektur
Erstellen von Providern für die Verwendung mit Zend_Tool_Framework
Mitgelieferte System Provider
Extending and Configuring Zend_Tool_Framework
Zend_Tool_Project
Einführung
Ein Projekt erstellen
Project Provider für Zend Tool
Zend_Translate
Einführung
Adapter für Zend_Translate
Benutzen von Übersetzungs Adaptoren
Erstellen von Quelldateien
Zusätzliche Features für Übersetzungen
Plurale Schreibweisen für Übersetzungen
Migration von vorhergehenden Versionen
Zend_Uri
Zend_Uri
Zend_Validate
Einführung
Standard Prüfklassen
Kettenprüfungen
Schreiben von Prüfern
Prüfungsmeldungen
Zend_Version
Die Version des Zend Frameworks erhalten
Zend_View
Einführung
Controller Skripte
View Scripte
View Helfer
Zend_View_Abstract
Migration von vorhergehenden Versionen
Zend_Wildfire
Zend_Wildfire
Zend_XmlRpc
Einführung
Zend_XmlRpc_Client
Zend_XmlRpc_Server
Zend Framework Voraussetzungen
Einführung
Zend Framework Coding Standard für PHP
Übersicht
PHP Dateiformatierung
Namens Konventionen
Code Stil
Zend Framework Dokumentations Standard
Übersicht
Formatierung von Dokumentationsdateien
Empfehlungen
Recommended Project Structure for Zend Framework MVC Applications
Overview
Recommended Project Directory Structure
Module Structure
Rewrite Configuration Guide
Zend Framework Performance Guide
Einführung
Laden von Klassen
Zend_Db Performance
Internationalisierung (I18n) und Lokalisierung (L10n)
Darstellen der View
Urheberrecht Informationen