LSformElement : add no_value_label parameter
[ldapsaisie.git] / doc / conf / LSattribute.docbook
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
7   attributs.</para>
8   
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>
13   
14 <programlisting linenumbering="unnumbered">
15 <citetitle>Structure</citetitle>...
16 <![CDATA['attrs' => array (
17   /* ----------- start -----------*/
18   'attr1' => array (
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
25     ),
26     'html_type' => 'htmltype1',
27     'html_options' => array(
28       // Options HTML liées au type HTML de l'attribut
29     ),
30     'no_value_label' => '[No set value label]',
31     'multiple' => 0,
32     'required' => 1,
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
38     ),
39     'validation' => array (
40       // Règle de vérification d'intégrité des données saisies
41     ),
42     'rights' => array(
43       'LSprofile1' => 'droit1',
44       'LSprofile2' => 'droit2',
45       ...
46     ),
47     'view' => 1,
48     'form' => array (
49       'create' => 1,
50       'modify' => 0,
51       ...
52     ),
53     'dependAttrs' => array(
54       // Attributs en dépendance
55     ),
56     'onDisplay' => 'fonction2'
57     
58     'before_modify' => 'function1',
59     'after_modify' => 'function2'
60   ),
61   /* ----------- end -----------*/
62   ...
63 );]]>
64 ...
65 </programlisting> 
66   
67 <!-- Début Paramètres Configuration -->  
68 <variablelist>
69 <title>Paramètres de configuration</title>
70
71 <varlistentry>
72   <term>label</term>
73   <listitem>
74     <simpara>Le label de l'attribut.</simpara>
75   </listitem>
76 </varlistentry>
77
78 <varlistentry>
79   <term>displayAttrName</term>
80   <listitem>
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>
83   </listitem>
84 </varlistentry>
85
86 <varlistentry>
87   <term>help_info</term>
88   <listitem>
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>
91   </listitem>
92 </varlistentry>
93
94 <varlistentry>
95   <term>ldap_type</term>
96   <listitem>
97     <simpara>Le type LDAP de l'attribut.
98     <link linkend='config-LSattr_ldap'>Voir la section concernée.</link></simpara>
99   </listitem>
100 </varlistentry>
101
102 <varlistentry>
103   <term>ldap_options</term>
104   <listitem>
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>
108   </listitem>
109 </varlistentry>
110
111 <varlistentry>
112   <term>html_type</term>
113   <listitem>
114     <simpara>Le type HTML de l'attribut.
115     <link linkend='config-LSattr_html'>Voir la section concernée.</link></simpara>
116   </listitem>
117 </varlistentry>
118
119 <varlistentry>
120   <term>html_options</term>
121   <listitem>
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>
125   </listitem>
126 </varlistentry>
127
128 <varlistentry>
129   <term>no_value_label</term>
130   <listitem>
131     <simpara>Label affiché lorsque l'attribut n'a pas de valeur (facultatif).</simpara>
132   </listitem>
133 </varlistentry>
134
135 <varlistentry>
136   <term>multiple</term>
137   <listitem>
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>
141   </listitem>
142 </varlistentry>
143
144 <varlistentry>
145   <term>required</term>
146   <listitem>
147     <simpara>Booléen définissant si cet attribut doit obligatoirement être
148     défini.</simpara>
149     <simpara>Valeurs possibles : <emphasis>0</emphasis> ou <emphasis>1</emphasis></simpara>
150     <simpara>Valeur par défaut : <emphasis>0</emphasis></simpara>
151   </listitem>
152 </varlistentry>
153
154 <varlistentry>
155   <term>generate_function</term>
156   <listitem>
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>
160   </listitem>
161 </varlistentry>
162
163 <varlistentry>
164   <term>generate_value_format</term>
165   <listitem>
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>
169   </listitem>
170 </varlistentry>
171
172 <varlistentry>
173   <term>default_value</term>
174   <listitem>
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>
179   </listitem>
180 </varlistentry>
181
182 <varlistentry>
183   <term>check_data</term>
184   <listitem>
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>
188   </listitem>
189 </varlistentry>
190
191 <varlistentry>
192   <term>validation</term>
193   <listitem>
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>
197   </listitem>
198 </varlistentry>
199
200 <varlistentry>
201   <term>rights</term>
202   <listitem>
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>
208   </listitem>
209 </varlistentry>
210
211 <varlistentry>
212   <term>view</term>
213   <listitem>
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>
218   </listitem>
219 </varlistentry>
220
221 <varlistentry>
222   <term>form</term>
223   <listitem>
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>
229   </listitem>
230 </varlistentry>
231
232 <varlistentry>
233   <term>dependAttrs</term>
234   <listitem>
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>
240   </listitem>
241 </varlistentry>
242
243 <varlistentry>
244   <term>onDisplay</term>
245   <listitem>
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>
250   </listitem>
251 </varlistentry>
252
253 <varlistentry>
254   <term>before_modify</term>
255   <listitem>
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>
259   </listitem>
260 </varlistentry>
261
262 <varlistentry>
263   <term>after_modify</term>
264   <listitem>
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>
268   </listitem>
269 </varlistentry>
270
271 </variablelist>  
272   &conf-LSattribute-LSattr_ldap;
273   &conf-LSattribute-LSattr_html;
274   
275   &conf-LSattribute-check-data;
276   &conf-LSattribute-validation;
277   &conf-LSattribute-triggers;
278   
279 </sect2>