Previous Next

Décorateurs standards fournis avec Zend Framework

Zend_Form est livré avec plusieurs décorateurs standards. Pour plus d'informations sur l'utilisation des décorateurs en général, voyez la section sur les décorateurs.

Zend_Form_Decorator_Callback

Le décorateur Callback peut exécuter une fonction de rappel pour rendre du contenu. Les fonctions doivent être spécifiées grâce à l'option 'callback' passée à la configuration du décorateur, et peut être n'importe quelle fonction PHP valide. Les fonctions peuvent accepter 3 arguments , $content ( le contenu original passé au décorateur), $element (l'objet étant décoré), et un tableau d'options $options. Voici un exemple :

class Util
{
    public static function label($content, $element, array $options)
    {
        return '' . $element->getLabel() . "";
    }
}

Cette fonction de rappel devrait être spécifiée avec array('Util', 'label'), et générera du (mauvais) code HTML pour le label. Le décorateur Callback remplacera, fera suivre ou précéder le contenu original avec la valeur qu'il retourne.

Le décorateur Callback accepte qu'on lui passe une valeur nulle pour l'option de placement, ce qui remplacera le contenu original par le contenu décoré. 'prepend' et 'append' restent cependant acceptés.

Zend_Form_Decorator_Captcha

Le décorateur Captcha est à utiliser avec l'élément de formulaire CAPTCHA. Il utilise la méthode render() de l'adaptateur de CAPTCHA pour générer son contenu.

Une variante du décorateur Captcha, 'Captcha_Word', est aussi utilisée quelques fois et créer 2 éléments, un id et un input. L'id indique l'identifiant de session à comparer et l'input est pour la saisie du CAPTCHA. Ces 2 éléments sont validés comme un seul.

Zend_Form_Decorator_Description

Le décorateur Description peut être utilisé pour afficher la description affectée à un Zend_Form, Zend_Form_Element, ou Zend_Form_DisplayGroup; il cherche cette description en utilisant getDescription() sur l'objet en question.

Par défaut, si aucune description n'est présente, rien ne sera généré. Dans le cas contraire , la description est entourée d'un tag HTML p par défaut, même si vous pouvez passer le tag que vous voulez en utilisant l'option tag à la création du décorateur, ou en utilisant sa méthode setTag(). Vous pouvez aussi spécifier une classe pour le tag en renseignant l'option class ou en appelant setClass().

La description est échappée en utilisant le mécanisme de l'objet de vue par défaut. Vous pouvez désactiver cette fonctionnalité en passant false à l'option 'escape' du décorateur ou via sa méthode setEscape().

Zend_Form_Decorator_DtDdWrapper

Les décorateurs par défaut utilisent des listes de définition (<dl>) pour rendre les éléments de formulaire. Comme les éléments d'un formulaire peuvent apparaître dans n'importe quel ordre, les groupe d'affichage et les sous-formulaires peuvent être encapsulés dedans. Afin de garder ces types d'éléments dans la liste de définition, DtDdWrapper crée une nouvelle définition vide (<dt>) et encapsule don contenu dans une nouvelle donnée de définition (<dd>). L'affichage ressemble alors à ceci :

User Information ...

Ce décorateur remplace le contenu qu'on lui fournit par ce même contenu entouré de <dd>.

Zend_Form_Decorator_Errors

Les erreurs des éléments possèdent leur propre décorateur : 'Errors'. Celui-ci utilise l'aide de vue FormErrors, qui rend les messages d'erreur dans une liste non ordonnée (<ul>) qui reçoit la classe d'affichage "errors".

Le décorateur 'Errors' peut faire suivre ou précéder son contenu.

Zend_Form_Decorator_Fieldset

Les groupes d'affichage et les sous-formulaires rendent leur contenu dans des balises HTML fieldsets par défaut. Le décorateur Fieldset vérifie une option 'legend' ou la méthode getLegend() dans l'élément, et l'utilise comme élément de légende si non vide. Tout contenu qu'on lui passe est entouré d'une balise HTML "fieldset", et remplace donc le contenu précédent. Tout attribut passé à l'élément décoré sera rendu comme attribut de la balise HTML fieldset.

Zend_Form_Decorator_File

Les éléments de type "File" (upload de fichiers) ont une notation spéciale lorsque vous utilisez de multiples éléments file ou des sous-formulaires. Le décorateur File est utilisé par Zend_Form_Element_File et autorise plusieurs éléments avec un seul appel de méthode. Il est utilisé automatiquement et gère alors le nom de chaque élément.

Zend_Form_Decorator_Form

Les objets Zend_Form ont en général besoin de rendre une balise HTML "form". Le décorateur Form utilise l'aide de vue du même nom dans ce but. Il encapsule le contenu qu'on lui passe dans une balise HTML 'form' et remplace donc ce contenu par le nouveau entouré. Les action, méthode et attributs de l'objet Zend_Form sont bien entendus utilisés dans la balise.

Zend_Form_Decorator_FormElements

Les formulaires, groupes d'affichage et sous-formulaires sont des collections d'éléments. Afin de rendre ces éléments, ils utilisent le décorateur FormElements, qui itère sur tous les éléments et appelle leur méthode render() en les joignant avec le séparateur. Il peut faire suivre ou précéder son contenu.

Zend_Form_Decorator_FormErrors

Certains développeurs ou designers préfèrent regrouper tous les messages d'erreur en haut du formulaire. Le décorateur FormErrors a été conçu dans ce but.

Par défaut, la liste d'erreurs générée ressemble à ceci :

    Vous pouvez lui passer un tas d'options afin de la configurer plus finement :

    • ignoreSubForms : ignore ou pas la récursion dans les sous-formulaires. Par défaut : false (autorise la récursion).

    • markupElementLabelEnd : balise à ajouter après le label des éléments. Par défaut: '</b>'

    • markupElementLabelStart : balise à ajouter avant le label des éléments. Par défaut: '<b>'

    • markupListEnd : balise à ajouter après la liste des messages d'erreur. Par défaut: '</ul>'.

    • markupListItemEnd : balise à ajouter après chaque message d'erreur. Par défaut: '</li>'

    • markupListItemStart : balise à ajouter avant chaque message d'erreur. Par défaut: '<li>'

    • markupListStart : balise à ajouter autour de la liste des messages d'erreur. Par défaut: '<ul class="form-errors">'

    Le décorateur FormErrors peut faire suivre ou précéder son contenu.

Zend_Form_Decorator_HtmlTag

Le décorateur HtmlTag vous permet d'utiliser une balise HTML pour décorer votre contenu. La balise utilisée est passée comme option 'tag' et toute autre option sera utilisée comme attribut HTML à cette balise. Par défaut, le contenu généré remplace le contenu reçu par le décorateur. Vous pouvez tout de même préciser un placement 'append' ou 'prepend'.

Zend_Form_Decorator_Image

Le décorateur Image vous permet de créer un tag HTML d'image (<input type="image" ... />), et optionnellement le rendre à l'intérieur d'une autre balise HTML.

Par défaut, le décorateur utilise la propriété 'src' , qui peut être renseignée grâce à la méthode setImage() (avec la source de l'image). Aussi, le label de l'élément va être utilisé comme propriété 'alt' de la balise et le propriété imageValue (manipulée grâce à setImageValue() et getImageValue()) sera utilisée comme valeur.

Pour spécifier une balise HTML à utiliser avec l'élément, passez l'option 'tag' au décorateur, ou utilisez sa méthode setTag().

Zend_Form_Decorator_Label

Les éléments de formulaire possèdent en général un label, et le décorateur du même nom permet de le rendre. Il utilise l'aide de vue FormLabel en récupérant le label de l'élément avec getLabel(). Si aucun label n'est présent, rien n'est rendu. Par défaut, les label sont traduits lorsqu'un objet de traduction existe.

Vous pouvez aussi spécifier optionnellement une option 'tag'. Si celle-ci est précisée, alors le label sera encapsulé dans la balise HTML en question. Si la balise est présente mais qu'il n'y a pas de label, alors la balise est rendu seule. Vous pouvez utiliser aussi une classe CSS grâce à l'option 'class' ou la méthode setClass().

Aussi, vous pouvez utiliser les préfixes ou des suffixes à afficher pour l'élément, selon si celui-ci est requis ou pas. Par exemple on peut imaginer que tout label est suivi du caractère ":". Aussi, tout élément requis à la saisie pourrait comporter une étoile "*". Des méthodes existent pour effectuer cela :

  • optionalPrefix: affecte le texte à préfixer au label si l'élément est optionnel. setOptionalPrefix() et getOptionalPrefix() existent aussi.

  • optionalSuffix: affecte le texte à suffixer au label si l'élément est optionnel. setOptionalSuffix() et getOptionalSuffix() existent aussi.

  • requiredPrefix: affecte le texte à préfixer au label si l'élément est marqué comme requis.setRequiredPrefix() et getRequiredPrefix() existent aussi.

  • requiredSuffix: affecte le texte à suffixer au label si l'élément est marqué comme requis.setRequiredSuffix() et getRequiredSuffix() existent aussi.

Par défaut, le décorateur Label préfixe son rendu vis à vis du contenu qu'on lui passe à décorer. L'option 'placement' reste disponible avec comme autre valeur possible 'append'

Zend_Form_Decorator_PrepareElements

Les formulaires, les groupes d'affichage et les sous-formulaires sont des collections d'éléments. Lors de l'utilisation du décorateur ViewScript dans vos formulaires, il peut être utile de récursivement passer l'objet de vue, le traducteur et tous les noms réels (notation tableau des sous-formulaires) aux éléments. Cette tache peut être effectuée grâce au décorateur 'PrepareElements'. En général, vous le marquerez en tant que premier décorateur de la pile.

$form->setDecorators(array(
    'PrepareElements',
    array('ViewScript', array('viewScript' => 'form.phtml')),
));

Zend_Form_Decorator_ViewHelper

Beaucoup d'éléments utilisent les aides de Zend_View pour leur propre rendu, et ceci est effectué grâce au décorateur ViewHelper. Avec lui, vous pouvez spécifier une option 'helper' pour lui indiquer explicitement l'aide de vue à utiliser. Si aucune ne lui est fournie, il utilise le nom de la classe de l'élément (moins le chemin : la dernière partie du nom de la classe) afin de déterminer l'aide de vue à utiliser. Par exemple, 'Zend_Form_Element_Text' cherchera l'aide de vue 'form' + 'Text' soit 'formText'.

Tout attributs ajoutés à l'élément sera passé à l'aide vue comme attribut de l'élément HTML résultant.

Par défaut, ce décorateur fait suivre son contenu au contenu qu'on lui passe.

Zend_Form_Decorator_ViewScript

Quelques fois, vous pouvez avoir besoin d'un script de vue pour afficher vos éléments. Ceci vous permettra un placement très fin et détaillé, ou alors de changer la vue utilisée en fonction du module MVC dans lequel vous vous situez, par exemple.

Le décorateur ViewScript nécessite une option 'viewScript'. Celle-ci peut aussi être passée à l'élément lui-même, via sa propriété 'viewScript'. Le décorateur rend alors ce script de vue comme un script partiel (ce qui signifie que chaque appel à lui possède son propre espace de variables). Plusieurs variables sont alors peuplées dans le script de vue :

  • element : l'élément décoré

  • content : le contenu passé au décorateur

  • decorator : l'objet décorateur lui-même

  • Aussi, toute variable passée au décorateur via setOptions() et qui n'est pas utilisée en interne (qui n'est pas 'placement', 'separator', etc.) est alors passée comme variable de vue.

Voici un exemple :

// Affectation d'un décorateur ViewScript à un seul élément
// en spécifiant comme option le script de vue (obligatoire) et d'autres options :
$element->setDecorators(array(array('ViewScript', array(
    'viewScript' => '_element.phtml',
    'class'      => 'form element'
))));

// OU spécifier le script de vue comme attribut de l'élément
$element->viewScript = '_element.phtml';
$element->setDecorators(array(array('ViewScript',
                                    array('class' => 'form element'))));

Le script de vue pourrait alors ressembler à cela :

formLabel($this->element->getName(), $this->element->getLabel()) ?> {$this->element->helper}( $this->element->getName(), $this->element->getValue(), $this->element->getAttribs() ) ?> formErrors($this->element->getMessages()) ?>
element->getDescription() ?>

Note: Remplacer le contenu avec un script de vue

Le contenu n'est pas remplacé par défaut, vous pouvez le demander en spécifiant l'option 'placement' du décorateur. Il existe plusieurs manières de faire :

// A la création du décorateur:
$element->addDecorator('ViewScript', array('placement' => false));

// Application au décorateur déja existant:
$decorator->setOption('placement', false);

// Application au décorateur déja ajouté à un élément:
$element->getDecorator('ViewScript')->setOption('placement', false);

// Depuis un script de vue:
$this->decorator->setOption('placement', false);

L'utilisation du décorateur ViewScript est recommandée dans les cas où vous souhaitez avoir un placement HTML très détaillé et très fin de vos éléments.

Previous Next
Introduction to Zend Framework
Présentation
Installation
Zend_Acl
Introduction
Affiner les Contrôles d'Accès
Utilisation avancée
Zend_Amf
Introduction
Zend_Amf_Server
Zend_Application
Introduction
Zend_Application Quick Start
Théorie générale
Exemples
Core Functionality
Available Resource Plugins
Zend_Auth
Introduction
Authentification avec une table de base de données
Authentification "Digest"
Adaptateur d'authentification HTTP
LDAP Authentication
Authentification OpenID
Zend_Cache
Introduction
Aspect théorique
Les frontends Zend_Cache
Les backends Zend_Cache
Zend_Captcha
Introduction
Opération Captcha
Adaptateurs CAPTCHA
Zend_CodeGenerator
Introduction
Exemples Zend_CodeGenerator
Zend_CodeGenerator Réference
Zend_Config
Introduction
Aspect théorique
Zend_Config_Ini
Zend_Config_Xml
Zend_Config_Writer
Zend_Config_Writer
Zend_Console_Getopt
Introduction
Déclarer les règles Getopt
Extraire les options et les arguments
Configurer Zend_Console_Getopt
Zend_Controller
Zend_Controller - Démarrage rapide
Fondations de Zend_Controller
Le contrôleur frontal (Front Controller)
L'objet Requête
Routeur Standard
Le distributeur
Contrôleurs d'action
Aides d'action (Helper)
Objet de réponse
Plugins
Utilisation de conventions de dossiers modulaires
Exceptions avec MVC
Migrer depuis des versions précédentes
Zend_Currency
Introduction à Zend_Currency
How to Work with Currencies
Migrer depuis des versions antérieures
Zend_Date
Introduction
Aspect théorique
Méthodes de base
Zend_Date API Overview
Créer des dates
Constants for General Date Functions
Exemples concrets
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
Relations Zend_Db_Table
Zend_Debug
Afficher des informations
Zend_Dojo
Introduction
Zend_Dojo_Data: dojo.data Envelopes
Les aides de vues Dojo
Les éléments de formulaire et les décorateurs Dojo
Zend_Dom
Introduction
Zend_Dom_Query
Zend_Exception
Utiliser les exceptions
Zend_Feed
Introduction
Importer des flux
Obtenir des flux à partir de pages Web
Consommer un flux RSS
Consommer un flux Atom
Consommer une entrée Atom particulière
Modifier la structure du flux ou des entrées
Classes personnalisées pour les flux et entrées
Zend_File
Zend_File_Transfer
Validateurs pour Zend_File_Transfer
Filtres pour Zend_File_Transfer
Migrer à partir des versions précédentes
Zend_Filter
Introduction
Classes de filtre standards
Chaînes de filtrage
Écriture de filtres
Zend_Filter_Input
Zend_Filter_Inflector
Zend_Form
Zend_Form
Zend_Form démarrage rapide
Creating Form Elements Using Zend_Form_Element
Creating Forms Using Zend_Form
Créer un visuel personnalisé en utilisant Zend_Form_Decorator
Standard Form Elements Shipped With Zend Framework
Décorateurs standards fournis avec Zend Framework
Internationaliser un formulaire Zend_Form
Advanced Zend_Form Usage
Zend_Gdata
Introduction
Authentification par procédé AuthSub
Using the Book Search Data API
Authentification avec ClientLogin
Using Google Calendar
Using Google Documents List Data API
Using Google Health
Using Google Spreadsheets
Using Google Apps Provisioning
Using Google Base
Utilisation des albums Web Picasa
Using the YouTube Data API
Attraper les exceptions Gdata
Zend_Http
Introduction
Zend_Http_Client - Utilisation avancée
Zend_Http_Client - Adaptateurs de connexion
Zend_Http_Cookie and Zend_Http_CookieJar
Zend_Http_Response
Zend_InfoCard
Introduction
Zend_Json
Introduction
Utilisation de base
Utilisation avancée de Zend_Json
XML to JSON conversion
Zend_Json_Server - JSON-RPC server
Zend_Layout
Introduction
Zend_Layout - Démarrage rapide
Zend_Layout options de configuration
Zend_Layout, utilisation avancée
Zend_Ldap
Introduction
Zend_Loader
Charger les fichiers et les classes dynamiquement
L'autoloader
Autoloaders de ressources
Chargeur de Plugins
Zend_Locale
Introduction
Using Zend_Locale
Normalization and Localization
Working with Dates and Times
Supported locales
Migrer à partir des versions précédentes
Zend_Log
Présentation
Rédacteurs (Writers)
Formateurs (mise en forme)
Filtres
Zend_Mail
Introduction
Envoyer des émail en utilisant SMTP
Envoyer plusieurs émail par connexion SMTP
Utiliser différents transports
Émail HTML
Fichiers joints
Ajouter des destinataires
Contrôler les limites MIME
En-têtes additionnels
Jeux de caractères
Encodage
Authentification SMTP
Sécuriser les transports SMTP
Lire des émail
Zend_Measure
Introduction
Création d'une mesure
Récupérer des mesures
Manipuler des mesures
Types de mesures
Zend_Memory
Présentation
Manager de mémoire
Objet mémoire
Zend_Mime
Zend_Mime
Zend_Mime_Message
Zend_Mime_Part
Zend_Navigation
Introduction
Pages
Containers
Zend_OpenId
Introduction
Zend_OpenId_Consumer Basics
Zend_OpenId_Provider
Zend_Paginator
Introduction
Utilisation
Configuration
Utilisation avancée
Zend_Pdf
Introduction
Créer et charger des documents PDF
Sauvegarder les changement dans un document PDF
Les pages d'un document
Dessiner
Informations du document et métadonnées
Exemple d'utilisation du module Zend_Pdf
Zend_ProgressBar
Zend_ProgressBar
Zend_Reflection
Introduction
Zend_Reflection Exemples
Réference de Zend_Reflection
Zend_Registry
Utiliser le registre
Zend_Rest
Introduction
Zend_Rest_Client
Zend_Rest_Server
Zend_Search_Lucene
Vue d'ensemble
Créer des index
Searching an Index
Query Language
Query Construction API
Jeu de caractères
Extensibility
Agir avec Lucene Java
Avancé
Bonnes pratiques
Zend_Server
Introduction
Zend_Server_Reflection
Zend_Service
Introduction
Zend_Service_Akismet
Zend_Service_Amazon
Zend_Service_Amazon_Ec2
Zend_Service_Amazon_Ec2: Instances
Zend_Service_Amazon_Ec2: Windows Instances
Zend_Service_Amazon_Ec2: Reserved Instances
Zend_Service_Amazon_Ec2: CloudWatch Monitoring
Zend_Service_Amazon_Ec2: Amazon Machine Images (AMI)
Zend_Service_Amazon_Ec2: Elastic Block Stroage (EBS)
Zend_Service_Amazon_Ec2: Elastic IP Addresses
Zend_Service_Amazon_Ec2: Keypairs
Zend_Service_Amazon_Ec2: Regions and Availability Zones
Zend_Service_Amazon_Ec2: Security Groups
Zend_Service_Amazon_S3
Zend_Service_Audioscrobbler
Zend_Service_Delicious
Zend_Service_Flickr
Zend_Service_Nirvanix
Zend_Service_ReCaptcha
Zend_Service_Simpy
Introduction
Zend_Service_StrikeIron
Zend_Service_StrikeIron: Bundled Services
Zend_Service_StrikeIron: Advanced Uses
Zend_Service_Technorati
Zend_Service_Twitter
Zend_Service_Yahoo
Zend_Session
Introduction
Usage basique
Utilisation avancée
Gestion générale de la session
Zend_Session_SaveHandler_DbTable
Zend_Soap
Zend_Soap_Server
Zend_Soap_Client
WSDL
Auto découverte
Zend_Tag
Introduction
Zend_Tag_Cloud
Zend_Test
Introduction
Zend_Test_PHPUnit
Zend_Text
Zend_Text_Figlet
Zend_Text_Table
Zend_TimeSync
Introduction
Utiliser Zend_TimeSync
Zend_Tool_Framework
Introduction
Using the CLI Tool
Architecture
Creating Providers to use with Zend_Tool_Framework
Shipped System Providers
Zend_Tool_Project
Zend_Tool_Project Introduction
Create A Project
Zend Tool Project Providers
Zend_Translate
Introduction
Adaptateurs pour Zend_Translate
Utiliser les adaptateurs de traduction
Migrer à partir des versions précédentes
Zend_Uri
Zend_Uri
Zend_Validate
Introduction
Classes de validation standard
Chaînes de validation
Écrire des validateurs
Validation Messages
Zend_Version
Lire la version de Zend Framework
Zend_View
Introduction
Scripts de contrôleur
Scripts de vue
Aides de vue
Zend_View_Abstract
Migration depuis les versions précédentes
Zend_Wildfire
Zend_Wildfire
Zend_XmlRpc
Introduction
Zend_XmlRpc_Client
Zend_XmlRpc_Server
Configuration système requise par Zend Framework
Introduction
Convention de codage PHP de Zend Framework
Vue d'ensemble
Formatage des fichiers PHP
Conventions de nommage
Style de codage
Zend Framework Performance Guide
Introduction
Chargement des classes
Zend_Db Performance
Internationalisation (i18n) and Localisation (l10n)
View Rendering
Informations de copyright