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
32 'generate_function' => 'fonction1',
33 'generate_value_format' => '[LSformat]',
34 'default_value' => 'valeur1',
35 'check_data' => array (
36 // Régle de vérification syntaxique des données saisies
38 'validation' => array (
39 // Règle de vérification d'intégrité des données saisies
42 'LSprofile1' => 'droit1',
43 'LSprofile2' => 'droit2',
52 'dependAttrs' => array(
53 // Attributs en dépendance
55 'onDisplay' => 'fonction2'
57 'before_modify' => 'function1',
58 'after_modify' => 'function2'
60 /* ----------- end -----------*/
66 <!-- Début Paramètres Configuration -->
68 <title>Paramètres de configuration</title>
73 <simpara>Le label de l'attribut.</simpara>
78 <term>displayAttrName</term>
80 <simpara>Booléen définissant si le nom de l'attribut doit être affiché en
81 préfixe du message d'aide (paramètre <parameter>help_info</parameter>).</simpara>
86 <term>help_info</term>
88 <simpara>Message d'aide qui sera affiché dans une bulle d'aide à côté du
89 nom de l'attribut dans les formulaires.</simpara>
94 <term>ldap_type</term>
96 <simpara>Le type LDAP de l'attribut.
97 <link linkend='config-LSattr_ldap'>Voir la section concernée.</link></simpara>
102 <term>ldap_options</term>
104 <simpara>Tableau associatif contenant les paramètres de configuration du
105 type LDAP de l'attribut.
106 <link linkend='config-LSattr_ldap'>Voir la section concernée.</link></simpara>
111 <term>html_type</term>
113 <simpara>Le type HTML de l'attribut.
114 <link linkend='config-LSattr_html'>Voir la section concernée.</link></simpara>
119 <term>html_options</term>
121 <simpara>Tableau associatif contenant les paramètres de configuration du
122 type HTML de l'attribut.
123 <link linkend='config-LSattr_html'>Voir la section concernée.</link></simpara>
128 <term>multiple</term>
130 <simpara>Booléen définissant si cet attribut peut stocker plusieurs valeurs.</simpara>
131 <simpara>Valeurs possibles : <emphasis>0</emphasis> ou <emphasis>1</emphasis></simpara>
132 <simpara>Valeur par défaut : <emphasis>0</emphasis></simpara>
137 <term>required</term>
139 <simpara>Booléen définissant si cet attribut doit obligatoirement être
141 <simpara>Valeurs possibles : <emphasis>0</emphasis> ou <emphasis>1</emphasis></simpara>
142 <simpara>Valeur par défaut : <emphasis>0</emphasis></simpara>
147 <term>generate_function</term>
149 <simpara>Nom de la fonction permettant de générer la valeur de l'attribut.
150 Cette fonction sera éxecutée, en passant en premier paramètre, l'objet
151 &LSobject; courant.</simpara>
156 <term>generate_value_format</term>
158 <simpara>&LSformat; permettant la génération de l'attribut.</simpara>
159 <note><simpara>Cette méthode de génération est utilisée uniquement si aucune fonction de génération
160 de la valeur n'est définie (paramètre <parameter>generate_function</parameter>).</simpara></note>
165 <term>default_value</term>
167 <simpara>Valeur par défaut de l'attribut.</simpara>
168 <simpara>Valeurs possibles : <emphasis>0</emphasis> ou <emphasis>1</emphasis></simpara>
169 <note><simpara>Cette valeur est également utilisée dans le cadre de la génération automatique
170 de la valeur de l'attribut si aucune autre méthode n'est disponible (via une fonction ou un &LSformat;).</simpara></note>
175 <term>check_data</term>
177 <simpara>Tableau associatif contenant les règles de vérification syntaxique
178 des données de l'attribut.<link linkend='config-LSattribute-check-data'>Voir
179 la section concernée.</link></simpara>
184 <term>validation</term>
186 <simpara>Tableau associatif contenant les règles de vérification d'intégrité
187 des données de l'attribut.<link linkend='config-LSattribute-validation'>Voir
188 la section concernée.</link></simpara>
195 <simpara>Tableau associatif dont les clés sont les noms des &LSprofiles; ayant
196 des droits sur cet attribut et les valeurs associées sont les droits
197 correspondants. La valeur des droits d'un &LSprofile; peut être
198 <literal>r</literal> pour le droit de lecture ou <literal>w</literal> pour
199 le droit de lecture-écriture. Par défaut, un &LSprofile; n'a aucun droit.</simpara>
206 <simpara>Booléen définissant si l'attribut est, ou non, affiché lors de la
207 visualisation des objets du type courant.</simpara>
208 <simpara>Valeurs possibles : <emphasis>0</emphasis> ou <emphasis>1</emphasis></simpara>
209 <simpara>Valeur par défaut : <emphasis>0</emphasis></simpara>
216 <simpara>Tableau associatif dont les clés sont les noms des &LSforms; et les
217 valeurs associées la définition de l'affichage dans ce &LSform;. Si cette
218 valeur vaut <emphasis>0</emphasis>, alors l'attribut sera lecture-seule et si
219 cette valeur vaut <emphasis>1</emphasis>, cet attribut sera affiché en
220 lecture-écriture.</simpara>
225 <term>dependAttrs</term>
227 <simpara>Tableau associatif listant les attributs dépendants de celui-ci.
228 Les attributs listés ici seront regénérés lors de chaque modification
229 de l'attribut courant. Cette génération sera effectué avec la fonction
230 définie dans le paramètre <varname>generate_function</varname> de
231 l'attribut.</simpara>
236 <term>onDisplay</term>
238 <simpara>Nom ou liste de nom des fonctions retournant les valeurs d'affichages
239 de l'attribut. Si c'est une liste, chacune des fonctions seront executée les
240 unes après les autres. Ces fonctions seront éxecutées, en passant en premier
241 paramètre, le tableau des valeurs de l'objet.</simpara>
246 <term>before_modify</term>
248 <simpara>Nom de la fonction qui sera exécutée avant toutes modifications de
249 la valeur de l'attribut.<link linkend="config-LSattribute-triggers">Voir la
250 section concernée</link></simpara>
255 <term>after_modify</term>
257 <simpara>Nom de la fonction qui sera exécutée après toutes modifications de
258 la valeur de l'attribut.<link linkend="config-LSattribute-triggers">Voir la
259 section concernée</link></simpara>
264 &conf-LSattribute-LSattr_ldap;
265 &conf-LSattribute-LSattr_html;
267 &conf-LSattribute-check-data;
268 &conf-LSattribute-validation;
269 &conf-LSattribute-triggers;