Datatype : Identifier -- Identifiant

Date de publication: le mardi 5 juin 2007 à 22h43
Dernière modification: par Pascal BOYER le samedi 19 février 2011 à 22h22

29/04/2005 3:48

Summary / Résumé

Generates a non-editable identification string.
Génère une chaîne de caractères (identifiant) non modifiable.

Properties / Propriétés

Description

This datatype allows the automatic generation of unique identification strings for objects. An instance of a class that makes use of this datatype will have a unique identification string generated whenever the object is published for the very first time. The identification string is system-wide and may consist of the following elements:
Ce datatype permet la génération automatique, pour les objets, d'identifiants uniques au format «chaînes de caractères». L'instance d'une classe utilisant ce datatype sera dont affectée d'un identifiant unique généré chaque fois qu'un objet est publié pour la première fois. Alors que sa taille dépend (???) du système, la chaîne de caractère peut être composée des éléments suivants:

• User configurable start-text
  Un préfixe configurable
• Automatically generated identification number (configurable start value and number of digits)
  Un numéro d'identification automatiquement généré (dont on peut configurer la valeur de départ et le nombre de chiffres qui le composent)
• User configurable end-text
  Un suffixe configurable

The system will increment the actual counter(s) whenever a new object is published. It will not decrement and reorganize the identification strings when an object is removed. The identification strings are generated and maintained by the system and thus they can not be modified using the object edit interface. The identification strings are generated based on the class type and the identification number of the class attribute. In other words, the identifiers do not depend on the objects' locations within the content node tree. In addition, the datatype may be used to represent several attributes within the same class. The following screenshot shows the class attribute edit interface for this datatype.
Le système incrémentera le(s) compteur(s) chaque fois qu'un nouvel objet est publié mais ne décrémentera ni ne réorganisera les identifiants lorsqu'un objet est supprimé. Les chaînes de caractères étant générées et maintenues par le système, elles ne peuvent donc être modifiées à partir de l'interface d'édition des objets. Les chaînes de caractères sont générées en fonction du type de classe et du numéro d'identification de l'attribut de classe. En d'autres termes, les identifiants ne dépendent pas de l'emplacement des objets dans l'arborescence. Par ailleurs, ce datatype peut être utilisé pour identifier plusieurs attributs d'une même classe. L'image ci-dessous illustre l'interface d'édition des attributs de classe dans le cas de ce datatype.

Class attribute edit interface for the "Identifier" datatype.
Interface d'édition des attributs de classe dans le cas du datatype «Identifiant».

Pretext / Préfixe

The "Pretext" parameter can be used to specify a desired start-text (all characters are allowed) that should appear before the automatically generated identification number. In the example above, the text "ABC" is used. This means that the identification strings generated for instances of this class will start with the letters "ABC".
Le paramètre Pretext (Pré-texte) est utilisé pour définir le préfixe (tous les caractères étant autorisés) que l'on souhaite voir apparaître avant le numéro d'identification automatiquement généré. Dans l'exemple ci-dessus, le texte ABC est utilisé comme préfixe, ce qui signifie que les chaînes de caractères générées pour les instances de cette classes commenceront par les trois lettres ABC.

Posttext / Suffixe

The "Posttext" parameter can be used to specify a desired end-text (all characters are allowed) that should appear after the automatically generated identification number. In the example above, the text "XYZ" is used. This means that the identification strings generated for instanced of this class will end with the letters "XYZ".
Le paramètre Posttext (Post-texte) est utilisé pour définir le suffixe (tous les caractères étant autorisés) que l'on souhaite voir apparaître à la fin du numéro d'identification automatiquement généré. Dans l'exemple ci-dessus, le texte XYZ est utilisé comme suffixe, ce qui signifie que les chaînes de caractères générées pour les instances de cette classes se termineront par les trois lettres XYZ.

Digits / Chiffres

The "Digits" parameter makes it possible to insert additional zeros in order to generate equally long identification strings. In the example above, the digits parameter is set to "2". This means that numbers below 10 will appear with a prepended zero: "01", "02", "03"..."09". If the parameter was set to "3", the system would generate "001", "002" and so on. The "Digits" parameter can not be used to set the actual range / stop value. It only makes it possible to prepend the actual number with zeros.
Le paramètre Digits (Nombres) permet d'insérer des zéros supplémentaires afin de générer des chaînes de caractères (identifiants) de la même longueur. Dans l'exemple ci-dessus, ce paramètre a pour valeur 2, ce qui signifie que les nombres inférieurs à 10 seront précédés d'un zéro: "01", "02", "03"..."09". Si la valeur de ce paramètre était 3 alors le système générerait les nombres "001", "002" etc. Ce paramètre ne peut être utilisé pour définir une plage de valeurs ou une valeur maximum mais seulement pour préfixer des nombres avec des zéros.

Start value / Valeur de départ

The "Start value" parameter can be used to specify a desired start value for the counter; the default value is zero. In the example above, the value "1" is used. This means that the counter will start at "1". Given all the parameters above, the identification string generated for the very first object will be "ABC01XYZ".
Le paramètre Start value (Valeur de départ) est utilisé pour spécifier la valeur de départ du compteur, la valeur par défaut étant zéro. Dans l'exemple ci-dessus, la valeur 1 est utilisée, ce qui signifie que le compteur démarrera à 1. Étant donné les autres paramètres de notre exemple, l'identifiant généré pour le tout premier objet sera ABC01XYZ.

Raw output / Sortie brute

The ".content" of an ezcontentobjectattribute object using this datatype returns a string containing the actual identification value.
La partie .content d'un objet ezcontentobjectattribute utilisant un attribut basé sur ce datatype renvoie une chaîne de caractère contenant la valeur d'identification.