Zend_Filter_InputZend_Filter_Input propose une manière générique de déclarer des filtres et des validateurs, de les appliquer comme un ensemble, à une collection de données, et enfin de récupérer ces données validées et filtrées. Les valeurs sont retournées échappées par défaut, pour une meilleure sécurité relative au HTML. Considérez cette classe comme une boite noire dans laquelle va passer une variable de collection, typiquement un tableau PHP représentant des données externes. Les données arrivent dans l'application depuis une source externe, donc potentiellement dangereuse, comme des variables de requête HTTP, d'un service Web, d'un fichier, ou autre. L'application demande alors à la boite noire l'accès à une ou plusieurs données, en spécifiant sous quelle forme elle s'attend à voir la donnée. La boite inspecte alors la donnée pour la valider, et ne la laisse sortir que si celle-ci respecte les règles que l'application demande. Grâce à une simple classe et un mécanisme facile, ceci encourage les développeurs à prendre des bonnes pratiques au regard de la sécurité des applications.
Pour utiliser Zend_Filter_Input :
Les sections suivantes expliquent comment manipuler la classe. Déclarer des règles de filtre et de validateurAvant de créer une instance de Zend_Filter_Input, déclarez deux tableaux de règles pour les filtres, et les validateurs. Ce tableau associatif met en relation le champ de la donnée dans le tableau originel et le nom du filtre/validateur. L'exemple qui suit indique que le champ "month" est filtré par un Zend_Filter_Digits, et le champ "account" est filtré par un Zend_Filter_StringTrim. Puis, une règle de validation s'appliquera au champ "account", celui-ci sera validé s'il ne contient que des caractères alphabétiques (lettres). Chaque clé du tableau $filters représente une donnée à laquelle sera appliqué le filtre correspondant en valeur de tableau. Le filtre peut être déclaré selon différents formats :
Un joker "
Créer le processeur de filtres et validateursLorsque vos tableaux de filtres et de validateurs ont été construits, passez les en argument au constructeur de Zend_Filter_Input. Ceci va retourner un objet pré-configuré qui saura alors traiter tout un tableau de données d'entrée.
Les données d'entrée peuvent être placées dans le troisième paramètre du constructeur. Ces données possèdent en clé leur nom, et en valeur leur valeur. Typiquement, les tableaux superglobaux $_GET et $_POST possèdent la structure idéale pour passer dans Zend_Filter_Input.
Aussi, la méthode setData() accepte les données de la même manière que le troisième argument du constructeur.
La méthode setData() réaffecte une nouveau tableau de valeurs d'entrée dans l'objet Zend_Filter_Input, en écrasant toute autre source s'y trouvant. Ceci est pratique afin de réutiliser des règles communes de filtres / validateurs, sur différentes sources. Récupérer les champs validés/filtré, et les éventuels rapportsUne fois l'objet configuré, et le tableau de données d'entrée passé, vous pouvez récupérer les rapports concernant les champs absents, invalides ou inconnus. Vous pouvez évidemment aussi récupérer les valeurs validées/filtrées des champs d'entrée valides. Demander si l'entrée est valideSi toutes les données d'entrée passent les règles de validation la méthode isValid() retourne TRUE. Si n'importe quelle donnée d'entrée n'est pas validée, ou est manquante, alors isValid() retourne FALSE.
Cette méthode accepte aussi un paramètre facultatif nommant un champ particulier dans la donnée d'entrée. Ceci permet une vérification individuelle.
Récupérer les infos des champs invalides, absents ou inconnus
Les valeurs retournées par getMessages() sont sous la forme d'un tableau dont la clé est la règle concernée et la valeur un tableau d'erreurs la concernant. Le tableau d'erreurs comporte en clé le nom de la règle déclarée qui peut être différent des noms de champs vérifiés par la règle. La méthode getMessages() retourne la fusion des tableaux retournés par getInvalid() et getMissing(). Ces méthodes retournent une sous-partie des messages correspondant soit aux échecs de validation, soit aux champs qui sont déclarés requis mais qui sont absents. La méthode getErrors() retourne un tableau associatif dont les clés sont des noms de règles et les valeurs associées des tableaux identifiants les erreurs. Les identifiants d'erreurs sont des chaînes constantes et figées, qui permettent d'identifier la raison de l'échec de validation, tandis que les messages associés sont eux-mêmes personnalisables. Voir Utilisation basique des validateurs pour plus d'information. Vous pouvez spécifier le message retourné par getMissing() en utilisant l'option "missingMessage", en tant qu'argument du constructeur de Zend_Filter_Input ou en utilisant l'option setOptions().
And you can also add a translator which gives you the ability to provide multiple languages for the messages which are returned by Zend_Filter_Input.
When you are using an application wide translator, then it will also be used by Zend_Filter_Input. In this case you will not have to set the translator manually. Le résultat de la méthode getUnknown() est un tableau associatif dont les clés sont des noms de champs et les valeurs sont les valeurs de champs correspondants. Les noms de champs sont dans ce cas les clés du tableau au lieu des noms de règles, car tout champs n'ayant pas de règles définies est considéré comme un champs inconnu. Récupérer les champs validesTout champ non invalide, non absent et non inconnu, est considéré comme valide. Vous pouvez alors en récupérer la valeur via un accesseur magique. Des méthodes classiques existent aussi, comme getEscaped() et getUnescaped().
Par défaut, récupérer un champ le passe automatiquement au travers de
Zend_Filter_HtmlEntities. Ce comportement est considéré comme
défaut pour un affichage en HTML. Le filtre
Warning
Escaping unvalidated fieldsAs mentioned before getEscaped() returns only validated fields. Fields which do not have an associated validator can not be received this way. Still, there is a possible way. You can add a empty validator for all fields. But be warned that using this notation introduces a security leak which could be used for cross-site scripting attacks. Therefor you should always set individual validators for each field. Il est possible de définir un autre filtre comme filtre par défaut pour récupération des champs. Ceci se fait via le constructeur :
Aussi, la méthode setDefaultEscapeFilter() fait la même chose :
Il est possible de passer une chaine, ou directement un objet instance de Zend_Filter. Les filtres d'échappement comme vus juste précédemment, doivent être spécifiés de cette manière là. S'ils avaient été spécifiés comme filtres dans le tableau de Zend_Filter_Input, ils auraient pu faire échouer les validateurs, car les filtres sont exécutés AVANT les validateurs. Aussi, il n'aurait plus été possible de proposer la donnée de sortie de manière échappée et non échappée. Ainsi, déclarer un filtre d'échappement des données devrait toujours être effectué en utilisant la méthode setDefaultEscapeFilter(), et non pas le tableau $filters. Comme il n'y a qu'une seule méthode getEscaped(), il ne peut y avoir qu'un seul filtre utilisé pour l'échappement. Il est cependant possible d'utiliser une chaine de filtre, ou encore de dériver la classe Zend_Filter_Input en créant d'autres méthodes de récupération de données, plus spécifiques. Utiliser des méta commandes pour contrôler les règles des filtres et validateursEn plus de déclarer un mapping entre des champs d'un tableau, et des validateurs et des filtres, il est possible d'utiliser des méta commandes pour contrôler le comportement de Zend_Filter_Input. Les méta commandes se présentent sous la forme de chaînes dans le tableau des filtres ou des validateurs. La méta commande FIELDSSi le nom de la règle d'un filtre ou validateur est différente du champs auquel elle doit s'appliquer, vous pouvez spécifier le nom du champ avec la méta commande "fields". Vous pouvez spécifier cette méta commande en utilisant la constante de classe Zend_Filter_Input::FIELDS. Dans l'exemple ci dessus, la règle applique le filtre "digits" au champ d'entrée nommé "mo". La chaine "month" devient alors un simple mnémonique pour cette règle, elle n'est pas utilisée comme nom de champ si celui-ci est renseigné avec la méta commande "fields", mais elle est utilisée comme nom de règle. La valeur par défaut de la méta commande "fields" est l'index de la règle courante. Dans l'exemple ci dessus, si la méta commande "fields" est omise, la règle s'appliquerait au champ "month". Un autre usage de la méta commande "fields" est pour préciser les champs aux filtres ou validateurs qui en attendent plusieurs en entrée. Si la méta commande "fields" est un tableau, alors le filtre/validateur correspondant aura comme argument la valeur des champs. Pensez au cas où l'on demande à l'utilisateur de saisir 2 fois son mot de passe. Imaginons un validateur qui prend en paramètre un tableau de champs et retourne TRUE si les champs sont égaux.
Si la validation échoue, alors le nom de la règle ( Méta commande PRESENCESi la valeur de cette méta commande est "required", alors le champ doit exister dans la donnée d'entrée. Autrement, il est reporté comme étant un champ manquant. Vous pouvez spécifier cette méta commande avec la constante de classe Zend_Filter_Input::PRESENCE. La valeur par défaut de cette méta commande est "optional". La méta commande DEFAULT_VALUESi le champ n'est pas présent dans la donnée d'entrée mais que celui-ci possède une méta commande "default", alors il obtient la valeur de la méta commande. Vous pouvez spécifier cette méta commande avec la constante de classe Zend_Filter_Input::DEFAULT_VALUE. La valeur de cette méta commande ne s'applique qu'avant l'invocation des validateurs, et seulement pour la règle en cours. Si vous utilisez pour une règle la méta commande FIELDS afin de définir un tableau de champs, vous pouvez définir un tableau pour la méta commande DEFAULT_VALUE. Les valeurs par défaut seront alors les clés correspondantes à chaque champ manquant. Si FIELDS définit de multiples champs mais que DEFAULT_VALUE est un scalaire, alors cette valeur scalaire sera utilisée pour tous les champs manquants. Il n'y a pas de valeur par défaut pour cette méta commande. La méta commande ALLOW_EMPTY
Par défaut, si un champ existe dans le tableau d'entrées, alors les
validateurs lui sont appliqués, même si la valeur de ce champs est la chaine vide
( Si la chaine vide doit pouvoir être considérée comme valide, utilisez la méta commande "allowEmpty" avec la valeur TRUE. Vous pouvez spécifier cette méta commande avec la constante de classe Zend_Filter_Input::ALLOW_EMPTY La valeur par défaut de cette méta commande est FALSE. Dans la cas peut commun ou vous déclarez une règle de validation avec aucun validateurs, mais que la méta commande "allowEmpty" est mise à FALSE (le champ est considéré invalide s'il est vide), Zend_Filter_Input retourne un message d'erreur par défaut que vous pouvez récupérer avec la méthode getMessages(). Ce message se change grâce à l'option "notEmptyMessage" spécifiée en constructeur de Zend_Filter_Input ou via la méthode setOptions().
La méta commande BREAK_CHAINPar défaut, si une règle possède plus d'un validateur, tous sont appliqués à la donnée d'entrée, et les éventuels messages d'erreur résultants sont la somme de tous les messages individuels des validateurs.
Si la valeur de la méta commande " Vous pouvez spécifier cette méta commande au moyen de la constante de classe Zend_Filter_Input::BREAK_CHAIN La valeur par défaut de cette méta commande est FALSE. La classe Zend_Validate est plus flexible lors du bris de la chaine d'exécution, par rapport à Zend_Filter_Input. Avec Zend_Validate, vous pouvez mettre l'option pour casser la chaine indépendamment pour chaque validateur. Avec Zend_Filter_Input, la méta commande "breakChainOnFailure" s'applique à tous les validateurs dans la règle. Pour un usage plus flexible, créez votre propre chaine de validation comme ceci :
La méta commande MESSAGESVous pouvez attribuer des messages d'erreur pour chaque validateur d'une règle grâce à la méta commande 'messages'. La valeur de cette méta commande varie si vous avez plusieurs validateurs dans une règle ou si vous voulez spécifier le message pour une erreur particulière concernant un des validateurs. Vous pouvez utiliser la constante de classe Zend_Filter_Input::MESSAGES pour définir cette méta commande. Voici un exemple simple qui enregistre un message d'erreur pour une validateur de chiffres. Si vous possédez plusieurs validateurs dont vous voulez personnaliser les messages d'erreur, utilisez alors un tableau comme valeur de la méta commande 'messages'. Chaque élément de ce tableau s'applique à un validateur au même niveau d'index. Ainsi, un validateur à l'index n verra son message d'erreur modifié si vous utilisez l'index n dans le tableau de la méta commande. Il est ainsi possible d'autoriser certains validateurs à faire usage de leur message d'erreur par défaut, alors que d'autres posséderont un message personnalisé. Si un des validateurs a plusieurs messages d'erreur, ils sont identifiés par une clé. Il existe différente clé dans chaque classe de validateur, ceux-ci servent d'identifiants pour les messages d'erreur. Chaque classe validateur définit aussi des constante pour les clés des messages d'erreur. Cette constante peut être utilisée dans la méta commande 'messages' en lui passant un tableau associatif plutôt qu'une chaine.
Vous devriez vous référer à la documentation de chaque validateur afin de savoir s'il retourne plusieurs messages d'erreur, les clés de ces messages et les jetons utilisables dans les modèles de message. Si vous n'avez qu'un seul validateur dans vos règles de validation ou que tous les validateurs ont le même message de paramétrer, alors ils peuvent être référencés la construction additionnelle de type tableau :
Utiliser des options pour définir des méta commandes pour toutes les règlesLes valeurs par défaut des méta commandes "allowEmpty", "breakChainOnFailure", et "presence" peuvent être dictées pour toutes les règles en utilisant l'argument $options du constructeur de Zend_Filter_Input.
Les méta commandes "fields", "messages", et "default" ne bénéficient pas d'un tel raccourci. Ajouter des espaces de noms comme noms de classesPar défaut, l'ajout d'un validateur ou d'un filtre sous forme de chaine, va faire en sort que Zend_Filter_Input cherche une correspondance sous l'espace de nom Zend_Filter_* et Zend_Validate_*. Si vous écrivez vos propres filtres (ou validateurs), la classe peut exister dans un autre espace de nom que Zend_Filter ou Zend_Validate. Il est alors possible de dire à Zend_Filter_Input de chercher dans ces espaces là. Ceci se fait via son constructeur :
Alternativement, vous pouvez utiliser les méthodes addValidatorPrefixPath($prefix, $path) ou addFilterPrefixPath($prefix, $path), qui proxie directement le chargeur de plugin utilisé par Zend_Filter_Input :
Il n'est pas possible de supprimer les espaces de nommage Zend_Filter et Zend_Validate. Les espaces définis par l'utilisateur sont cherchés en premiers, les espaces de nom Zend sont cherchés en derniers.
|