Class attributes -- Attributs de classe

Date de publication: le mardi 22 mars 2011 à 18h00
Dernière modification: par Pascal BOYER le lundi 28 mars 2011 à 12h57

28/09/2010 10:30

versions 3.9, 3.10, 4.x

A content class is made up of one or more attributes where each attribute is represented by a datatype. The characteristics of an attribute are determined by the datatype that is chosen for that specific attribute. An attribute is made up of the following elements: 
Une classe de contenu est construite à partir d'un ou plusieurs attributs, chacun d'eux étant représenté par un type de données. Les caractéristiques d'un attribut sont déterminées par le datatype choisi pour cet attribut. Un attribut est constitué des éléments suivants:

• Name 
  un nom d'attribut

• Identifier 
  un identifiant d'attribut

• Generic controls 
  de contrôles génériques

• Datatype specific controls 
  de contrôles spécifiques au datatype.

Name / Le nom de l'attribut

The name is for storing a user friendly name for the attribute. For example, if the attribute is supposed to store birth dates, the name of the attribute would most likely be "Date of birth". This string will appear in various parts of the administration interface, but it will not be used internally by the system. The name of an attribute can consist of letters, digits, spaces and special characters. The maximum length is 255 characters. If a blank name is provided, eZ Publish will automatically generate a unique name for the attribute when the class definition is stored. 
Le nom sert à stocker un nom évocateur (choisi par l'utilisateur) pour l'attribut. Si l'attribut est sensé stocker, par exemple, une date anniversaire, le nom de l'attribut pourrait être "Date anniversaire". Cette chaîne de caractères apparaîtra dans différentes parties de l'interface d'administration mais ne sera pas utilisée en interne par le système. Le nom d'un attribut peut être composé de lettres, de chiffres et de caractères spéciaux mais ne devra pas excéder 255 caractères. Si le champ est laissé vide, eZ Publish génèrera automatiquement un nom d'attribut unique lors de l'enregistrement de la classe.

Identifier / L'identifiant de l'attribut

The identifier of an attribute is for internal use. In particular, attribute identifiers are used in configuration files, templates and in PHP code. An attribute identifier can only consist of lowercase letters, digits and underscores. The maximum length is 50 characters. For example, if the attribute is supposed to store birth dates, the identifier of the attribute would probably be "date_of_birth". If a blank identifier is provided, eZ Publish will automatically generate a unique identifier when the class definition is stored. 
L'identifiant d'un attribut ne sert que pour le fonctionnement interne du système. En particulier, les identifiants d'attributs sont utilisés par les fichiers de configuration, les templates et les codes PHP. Un identifiant d'attribut ne peut être composé que de minuscules, de chiffres et d'underscrores ("_") et ne peut excéder 50 caractères. Par exemple, si l'attribut est supposé stocker des dates anniversaire, l'identifiant de l'attribut sera probablement "date_anniversaire". Si aucun identifiant n'est fourni (champ d'identifiant laissé vide), eZ Publish génèrera automatiquement un identifiant unique lors de la sauvegarde de la classe.

Generic controls / Les contrôles génériques des attributs

Each attribute has a set of generic controls. These controls are the same for each attribute, regardless (but not independent) of the datatype that represents the attribute. The generic controls are a set of switches that can be turned on or off: 
Tous les attributs contiennent un même jeu de contrôles génériques. Ces contrôles, qui ne tiennent pas compte (sans être indépendant) du datatype qui représente l'attribut, sont un jeu de "commutateurs" (des boutons radio) pouvant être positionnés sur On ou Off:

:
Ndt: La traduction proposée ci-dessous des 4 contrôles génériques correspond exactement à celle que vous trouverez dans l'interface graphique d'édition des classes sous eZ Publish 4.x.

• Required 
  Obligatoire

• Searchable 
  Interrogeable

• Information collector 
  Collecteur d'information

• Translatable 
  Désactiver la traduction

Required / Obligatoire

The required switch controls the behavior of the storage procedure for content objects (instances of a content class). It can be used regardless of the datatype that represents the attribute. When the required flag of an attribute is set, the system will keep rejecting the inputted data until all required information is provided. If the required flag is unset, eZ Publish will not care whether any actual data was provided or not. When an attribute is added, the required switch is off. Please note that inputted data will be validated according to the chosen datatype's validation rules regardless of the state of the attribute's required switch. Input validation is supported by most (but not all) of the built in datatypes. The following example demonstrates how these features actually work. 
Le bouton radio Obligatoire contrôle le comportement de la procédure de stockage des objets de contenus (i.e les instances d'une classe de contenu) et peut être utilisé indépendamment du datatype qui représente l'attribut. Lorsque le drapeau Obligatoire d'un attribut est positionné à On (bouton radio sélectionné) alors le système refuse d'enregistrer l'objet instancié tant que tous les champs obligatoires ne sont pas renseignés. Si le drapeau Obligatoire n'est pas positionné (bouton radio non sélectionné), alors eZ Publish ne vérifie pas la présence ou non de données dans les champs. Enfin, lorsqu'un attribut est ajouté à une classe, le commutateur Obligatoire est positionné sur Off par défaut. Retenez que les données saisies seront validées en accord avec les règles de validation du datatype et sans tenir compte de l'état du commutateur Obligatoire de l'attribut. La validation des entrées est supportée par la plupart (mais pas par tous) des datatypes présents par défaut. L'exemple suivant illustre la façon dont ces fonctionnalités fonctionnent vraiment.

Let's say that we have created a content class that defines a data structure for storing information about prisoners. The class would typically consist of various attributes for storing different kinds of data: name, identification number, date of birth, cell, block, etc. Having at least the name and the birth date attributes required will eliminate the possibility of storing convicts without names and/or birth dates. If the birthdate attribute is represented by the built-in "date" datatype, the system will only accept the input if the birthdate is provided using a correct date format. 
Supposons que nous ayons créé une classe de contenu définissant une structure de données permettant de stocker des informations sur des prisonniers. Cette classe se composera de différents attributs pour stocker différentes sortes d'informations: nom, numéro d'identifiant du prisonnier, date de naissance, cellule, bloc, etc... En définissant au moins les attributs nom et date de naissance comme étant obligatoires, on élimine la possibilité d'enregistrer un prisonnier sans nom ni date de naissance. Si l'attribut date de naissance est représenté par le datatype Date alors le système n'acceptera comme information pour ce champ que des dates ayant le bon format.

Searchable / Interrogeable (indexable pour la recherche)

The searchable switch can be used to control whether the actual data stored using the attribute should be indexed by the search engine or if it should be left unindexed. Search indexing is supported by the majority of the built-in datatypes. Please refer to the Datatypes  section of the reference chapter to see which datatypes that support search indexing. 
Le bouton radio Interrogeable est utilisé pour contrôler si les données stockées doivent ou non être indexées par le moteur de recherche. L'indexation pour la recherche est supportée par la majorité des datatypes proposés par défaut. Référez-vous à la section Datatype  pour savoir quels datatypes supportent cette fonction.

Information collector / Collecteur d'informations

The information collector switch can be used to control the attribute's behavior in view mode. The default view mode behavior results in the display of the information that was provided in edit mode. For example, when viewing a news article, the contents of the article are displayed but can not be edited. However, if an attribute is marked as a collector, it will allow information to be input in view mode. At first, this feature might seem a bit odd. However, it is actually quite handy. For example, it can be used to quickly create simple feedback forms. The contents of a form created using this technique will be e-mailed to the site administrator (or to a specified address) once the form is submitted. Information collection is only supported by a small set of the built in datatypes. The following example demonstrates how this feature could be used to create a basic feedback form. 
Le bouton radio Collecteur d'informations est utilisé pour contrôler le comportement de l'attribut dans le mode view. Le comportement par défaut du mode view résulte en l'affichage des informations saisies dans le mode edit. Lorsque l'on affiche par exemple un article de news, le contenu de l'article est affiché mais ne peut être édité. Cependant, si un attribut est marqué Collecteur d'informations, alors des informations pourront être ajoutées en mode view. A première vue, cette fonctionnalité peut sembler un peu étrange. Mais elle est en fait très pratique et peut être utilisée, par exemple, pour créer rapidement des formulaires de retour. Le contenu d'un formulaire créé en utilisant cette technique sera envoyé par mail à l'administrateur du site (ou à une autre adresse) une fois le formulaire validé. La collection d'informations n'est supportée que par quelques datatypes. L'exemple suivant illustre comment créer un formulaire en utilisant cette méthode.

Let's say that we have created a content class called "Feedback form" using the following attributes: name, subject and message. The subject and the message attributes would be marked as information collectors. When an instance of this class is viewed, the subject and the message attributes will be displayed as input fields along with a "Send" button. 
Supposons que nous ayons créé une classe de contenu nommée Feeback form et qu'elle utilise les attributs suivants: nom, sujet et message. Les attributs sujet et message seront collecteurs d'information. Lorsqu'une instance de cette classe est affichée, les attributs sujet et message sont affichés comme des champs de saisie et un bouton "Envoyer" est également affiché.

Translatable / Désactiver la traduction

The translatable switch controls whether actual data stored using the attribute should exist in only one language (the default language) or if it should be possible to translate it using the additional languages. The translation mechanism is completely independent of the datatype layer. In other words, this switch can be used regardless of the datatype that was chosen to represent the attribute. 
Le bouton radio Désactiver la traduction contrôle si les données stockées utilisant l'attribut ne peuvent exister que dans une seule langue (celle définie comme langue par défaut) ou être traduites dans d'autres langues. Le mécanisme de traduction est totalement indépendant de la couche datatype. En d'autres termes, ce commutateur est utilisé sans tenir compte du datatype choisi pour représenter l'attribut.

When an attribute is added, the translation switch is "on". Turning it off is typically useful when the attribute is supposed to store non-translatable input. For example, translating dates, numerical values, prices, email addresses, etc. doesn't make much sense. 
Par défaut, lorsqu'un attribut est ajouté, le bouton radio Désactiver la traduction est sur On. Le mettre à Off est particulièrement recommandé lorsque l'attribut est sensé stocker des données non traduisibles. Par exemple, la traduction des dates, des valeurs numériques, des prix, des adresses mail, etc... n'a aucun sens.

Datatype specific controls / Les contrôles spécifiques de certains datatypes

An attribute can have a set of additional controls that are specific for the datatype that was chosen to represent that attribute. Some datatypes allow fine grained customization, some not. For example, the built-in "Text line" datatype provides two settings: default value and maximum length. 
Un attribut peut avoir un jeu de contrôles supplémentaires spécifiques au datatype choisi pour représenter l'attribut. Certains datatypes permettent une personnalisation poussée, d'autres non. Le datatype Ligne de texte par exemple, contient deux paramètres: valeur par défaut et taille maximum.

Commentaires