1 <sect2 id="config-LSattribute">
2 <title>Configuration des attributs</title>
3 <para>Cette section décrit les options de configuration des attributs des
4 &LSobjects;. Les attributs sont définis dans le tableau associatif
5 <varname>attrs</varname> de la configuration des &LSobjects;. Dans ce tableau,
6 les clé les noms des attributs et les valeurs liés sont la configuration des
9 <warning><simpara>Contrairement à ce qui existe dans le standard LDAP, les
10 noms des attributs sont sensibles à la casse. Il faut que le nom des attributs
11 dans &LdapSaisie; soient scrupuleusement les mêmes que ceux retourné par
12 &netldap;</simpara></warning>
14 <programlisting linenumbering="unnumbered">
15 <citetitle>Structure</citetitle>...
16 <![CDATA['attrs' => array (
17 /* ----------- start -----------*/
19 'label' => '[label de l'attr1',
20 'displayAttrName' => '[booleen]',
21 'help_info' => '[Message d'aide sur l'attribut attr1]',
22 'ldap_type' => 'ldaptype1',
23 'ldap_options' => array(
24 // Options LDAP liées au type LDAP de l'attribut
26 'html_type' => 'htmltype1',
27 'html_options' => array(
28 // Options HTML liées au type HTML de l'attribut
30 'no_value_label' => '[No set value label]',
33 'generate_function' => 'fonction1',
34 'generate_value_format' => '[LSformat]',
35 'default_value' => 'valeur1',
36 'check_data' => array (
37 // Régle de vérification syntaxique des données saisies
39 'validation' => array (
40 // Règle de vérification d'intégrité des données saisies
43 'LSprofile1' => 'droit1',
44 'LSprofile2' => 'droit2',
53 'dependAttrs' => array(
54 // Attributs en dépendance
56 'onDisplay' => 'fonction2'
58 'before_modify' => 'function1',
59 'after_modify' => 'function2'
61 /* ----------- end -----------*/
67 <!-- Début Paramètres Configuration -->
69 <title>Paramètres de configuration</title>
74 <simpara>Le label de l'attribut.</simpara>
79 <term>displayAttrName</term>
81 <simpara>Booléen définissant si le nom de l'attribut doit être affiché en
82 préfixe du message d'aide (paramètre <parameter>help_info</parameter>).</simpara>
87 <term>help_info</term>
89 <simpara>Message d'aide qui sera affiché dans une bulle d'aide à côté du
90 nom de l'attribut dans les formulaires.</simpara>
95 <term>ldap_type</term>
97 <simpara>Le type LDAP de l'attribut.
98 <link linkend='config-LSattr_ldap'>Voir la section concernée.</link></simpara>
103 <term>ldap_options</term>
105 <simpara>Tableau associatif contenant les paramètres de configuration du
106 type LDAP de l'attribut.
107 <link linkend='config-LSattr_ldap'>Voir la section concernée.</link></simpara>
112 <term>html_type</term>
114 <simpara>Le type HTML de l'attribut.
115 <link linkend='config-LSattr_html'>Voir la section concernée.</link></simpara>
120 <term>html_options</term>
122 <simpara>Tableau associatif contenant les paramètres de configuration du
123 type HTML de l'attribut.
124 <link linkend='config-LSattr_html'>Voir la section concernée.</link></simpara>
129 <term>no_value_label</term>
131 <simpara>Label affiché lorsque l'attribut n'a pas de valeur (facultatif).</simpara>
136 <term>multiple</term>
138 <simpara>Booléen définissant si cet attribut peut stocker plusieurs valeurs.</simpara>
139 <simpara>Valeurs possibles : <emphasis>0</emphasis> ou <emphasis>1</emphasis></simpara>
140 <simpara>Valeur par défaut : <emphasis>0</emphasis></simpara>
145 <term>required</term>
147 <simpara>Booléen définissant si cet attribut doit obligatoirement être
149 <simpara>Valeurs possibles : <emphasis>0</emphasis> ou <emphasis>1</emphasis></simpara>
150 <simpara>Valeur par défaut : <emphasis>0</emphasis></simpara>
155 <term>generate_function</term>
157 <simpara>Nom de la fonction permettant de générer la valeur de l'attribut.
158 Cette fonction sera éxecutée, en passant en premier paramètre, l'objet
159 &LSobject; courant.</simpara>
164 <term>generate_value_format</term>
166 <simpara>&LSformat; permettant la génération de l'attribut.</simpara>
167 <note><simpara>Cette méthode de génération est utilisée uniquement si aucune fonction de génération
168 de la valeur n'est définie (paramètre <parameter>generate_function</parameter>).</simpara></note>
173 <term>default_value</term>
175 <simpara>Valeur par défaut de l'attribut.</simpara>
176 <simpara>Valeurs possibles : <emphasis>0</emphasis> ou <emphasis>1</emphasis></simpara>
177 <note><simpara>Cette valeur est également utilisée dans le cadre de la génération automatique
178 de la valeur de l'attribut si aucune autre méthode n'est disponible (via une fonction ou un &LSformat;).</simpara></note>
183 <term>check_data</term>
185 <simpara>Tableau associatif contenant les règles de vérification syntaxique
186 des données de l'attribut.<link linkend='config-LSattribute-check-data'>Voir
187 la section concernée.</link></simpara>
192 <term>validation</term>
194 <simpara>Tableau associatif contenant les règles de vérification d'intégrité
195 des données de l'attribut.<link linkend='config-LSattribute-validation'>Voir
196 la section concernée.</link></simpara>
203 <simpara>Tableau associatif dont les clés sont les noms des &LSprofiles; ayant
204 des droits sur cet attribut et les valeurs associées sont les droits
205 correspondants. La valeur des droits d'un &LSprofile; peut être
206 <literal>r</literal> pour le droit de lecture ou <literal>w</literal> pour
207 le droit de lecture-écriture. Par défaut, un &LSprofile; n'a aucun droit.</simpara>
214 <simpara>Booléen définissant si l'attribut est, ou non, affiché lors de la
215 visualisation des objets du type courant.</simpara>
216 <simpara>Valeurs possibles : <emphasis>0</emphasis> ou <emphasis>1</emphasis></simpara>
217 <simpara>Valeur par défaut : <emphasis>0</emphasis></simpara>
224 <simpara>Tableau associatif dont les clés sont les noms des &LSforms; et les
225 valeurs associées la définition de l'affichage dans ce &LSform;. Si cette
226 valeur vaut <emphasis>0</emphasis>, alors l'attribut sera lecture-seule et si
227 cette valeur vaut <emphasis>1</emphasis>, cet attribut sera affiché en
228 lecture-écriture.</simpara>
233 <term>dependAttrs</term>
235 <simpara>Tableau associatif listant les attributs dépendants de celui-ci.
236 Les attributs listés ici seront regénérés lors de chaque modification
237 de l'attribut courant. Cette génération sera effectué avec la fonction
238 définie dans le paramètre <varname>generate_function</varname> de
239 l'attribut.</simpara>
244 <term>onDisplay</term>
246 <simpara>Nom ou liste de nom des fonctions retournant les valeurs d'affichages
247 de l'attribut. Si c'est une liste, chacune des fonctions seront executée les
248 unes après les autres. Ces fonctions seront éxecutées, en passant en premier
249 paramètre, le tableau des valeurs de l'objet.</simpara>
254 <term>before_modify</term>
256 <simpara>Nom de la fonction qui sera exécutée avant toutes modifications de
257 la valeur de l'attribut.<link linkend="config-LSattribute-triggers">Voir la
258 section concernée</link></simpara>
263 <term>after_modify</term>
265 <simpara>Nom de la fonction qui sera exécutée après toutes modifications de
266 la valeur de l'attribut.<link linkend="config-LSattribute-triggers">Voir la
267 section concernée</link></simpara>
272 &conf-LSattribute-LSattr_ldap;
273 &conf-LSattribute-LSattr_html;
275 &conf-LSattribute-check-data;
276 &conf-LSattribute-validation;
277 &conf-LSattribute-triggers;