9e83b4da5a54e6905d21893ba955d9ee756a5f24
[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     'help_info' => '[Message d'aide sur l'attribut attr1',
21     'ldap_type' => 'ldaptype1',
22     'ldap_options' => array(
23       // Options LDAP liées au type LDAP de l'attribut
24     ),
25     'html_type' => 'htmltype1',
26     'html_options' => array(
27       // Options HTML liées au type HTML de l'attribut
28     ),
29     'multiple' => 0,
30     'required' => 1,
31     'default_value' => 'valeur1',
32     'check_data' => array (
33       // Régle de vérification syntaxique des données saisies
34     ),
35     'validation' => array (
36       // Règle de vérification d'intégrité des données saisies
37     ),
38     'rights' => array(
39       'LSprofile1' => 'droit1',
40       'LSprofile2' => 'droit2',
41       ...
42     ),
43     'view' => 1,
44     'form' => array (
45       'create' => 1,
46       'modify' => 0,
47       ...
48     ),
49     'dependAttrs' => array(
50       // Attributs en dépendance
51     ),
52     'generate_function' => 'fonction1'
53   ),
54   /* ----------- end -----------*/
55   ...
56 );]]>
57 ...
58 </programlisting> 
59   
60 <!-- Début Paramètres Configuration -->  
61 <variablelist>
62 <title>Paramètres de configuration</title>
63
64 <varlistentry>
65   <term>label</term>
66   <listitem>
67     <simpara>Le label de l'attribut.</simpara>
68   </listitem>
69 </varlistentry>
70
71
72 <varlistentry>
73   <term>help_info</term>
74   <listitem>
75     <simpara>Message d'aide qui sera affiché dans une bulle d'aide à côté du
76     nom de l'attribut dans les formulaires.</simpara>
77   </listitem>
78 </varlistentry>
79
80 <varlistentry>
81   <term>ldap_type</term>
82   <listitem>
83     <simpara>Le type LDAP de l'attribut.
84     <link linkend='config-LSattr_ldap'>Voir la section concernée.</link></simpara>
85   </listitem>
86 </varlistentry>
87
88 <varlistentry>
89   <term>ldap_options</term>
90   <listitem>
91     <simpara>Tableau associatif contenant les paramètres de configuration du
92     type LDAP de l'attribut.
93     <link linkend='config-LSattr_ldap'>Voir la section concernée.</link></simpara>
94   </listitem>
95 </varlistentry>
96
97 <varlistentry>
98   <term>html_type</term>
99   <listitem>
100     <simpara>Le type HTML de l'attribut.
101     <link linkend='config-LSattr_html'>Voir la section concernée.</link></simpara>
102   </listitem>
103 </varlistentry>
104
105 <varlistentry>
106   <term>html_options</term>
107   <listitem>
108     <simpara>Tableau associatif contenant les paramètres de configuration du
109     type HTML de l'attribut.
110     <link linkend='config-LSattr_html'>Voir la section concernée.</link></simpara>
111   </listitem>
112 </varlistentry>
113
114 <varlistentry>
115   <term>multiple</term>
116   <listitem>
117     <simpara>Booléen définissant si cet attribut peut stocker plusieurs valeurs.</simpara>
118     <simpara>Valeurs possibles : <emphasis>0</emphasis> ou <emphasis>1</emphasis></simpara>
119     <simpara>Valeur par défaut : <emphasis>0</emphasis></simpara>
120   </listitem>
121 </varlistentry>
122
123 <varlistentry>
124   <term>required</term>
125   <listitem>
126     <simpara>Booléen définissant si cet attribut doit obligatoirement être
127     défini.</simpara>
128     <simpara>Valeurs possibles : <emphasis>0</emphasis> ou <emphasis>1</emphasis></simpara>
129     <simpara>Valeur par défaut : <emphasis>0</emphasis></simpara>
130   </listitem>
131 </varlistentry>
132
133 <varlistentry>
134   <term>default_value</term>
135   <listitem>
136     <simpara>Valeur par défaut de l'attribut.</simpara>
137     <simpara>Valeurs possibles : <emphasis>0</emphasis> ou <emphasis>1</emphasis></simpara>
138   </listitem>
139 </varlistentry>
140
141 <varlistentry>
142   <term>check_data</term>
143   <listitem>
144     <simpara>Tableau associatif contenant les règles de vérification syntaxique
145     des données de l'attribut.<link linkend='config-LSattribute-check-data'>Voir
146     la section concernée.</link></simpara>
147   </listitem>
148 </varlistentry>
149
150 <varlistentry>
151   <term>validation</term>
152   <listitem>
153     <simpara>Tableau associatif contenant les règles de vérification d'intégrité
154     des données de l'attribut.<link linkend='config-LSattribute-validation'>Voir
155     la section concernée.</link></simpara>
156   </listitem>
157 </varlistentry>
158
159 <varlistentry>
160   <term>rights</term>
161   <listitem>
162     <simpara>Tableau associatif dont les clés sont les noms des &LSprofiles; ayant
163     des droits sur cet attribut et les valeurs associées sont les droits
164     correspondants. La valeur des droits d'un &LSprofile; peut être
165     <literal>r</literal> pour le droit de lecture ou <literal>w</literal> pour
166     le droit de lecture-écriture. Par défaut, un &LSprofile; n'a aucun droit.</simpara>
167   </listitem>
168 </varlistentry>
169
170 <varlistentry>
171   <term>view</term>
172   <listitem>
173     <simpara>Booléen définissant si l'attribut est, ou non, affiché lors de la
174     visualisation des objets du type courant.</simpara>
175     <simpara>Valeurs possibles : <emphasis>0</emphasis> ou <emphasis>1</emphasis></simpara>
176     <simpara>Valeur par défaut : <emphasis>0</emphasis></simpara>
177   </listitem>
178 </varlistentry>
179
180 <varlistentry>
181   <term>form</term>
182   <listitem>
183     <simpara>Tableau associatif dont les clés sont les noms des &LSforms; et les
184     valeurs associées la définition de l'affichage dans ce &LSform;. Si cette
185     valeur vaut <emphasis>0</emphasis>, alors l'attribut sera lecture-seule et si
186     cette valeur vaut <emphasis>1</emphasis>, cet attribut sera affiché en
187     lecture-écriture.</simpara>
188   </listitem>
189 </varlistentry>
190
191 <varlistentry>
192   <term>dependAttrs</term>
193   <listitem>
194     <simpara>Tableau associatif listant les attributs dépendants de celui-ci. 
195     Les attributs listés ici seront regénérés lors de chaque modification
196     de l'attribut courant. Cette génération sera effectué avec la fonction
197     définie dans le paramètre <varname>generate_function</varname> de
198     l'attribut.</simpara>
199   </listitem>
200 </varlistentry>
201
202 <varlistentry>
203   <term>generate_function</term>
204   <listitem>
205     <simpara>Nom de la fonction permettant de générer la valeur de l'attribut.
206     Cette fonction sera éxecutée, en passant en premier paramètre, l'objet 
207     &LSobject; courant.</simpara>
208   </listitem>
209 </varlistentry>
210
211 <varlistentry>
212   <term>before_modify</term>
213   <listitem>
214     <simpara>Nom de la fonction qui sera exécutée avant toutes modifications de
215     la valeur de l'attribut.<link linkend="config-LSattribute-triggers">Voir la
216     section concernée</link></simpara>
217   </listitem>
218 </varlistentry>
219
220 <varlistentry>
221   <term>after_modify</term>
222   <listitem>
223     <simpara>Nom de la fonction qui sera exécutée après toutes modifications de
224     la valeur de l'attribut.<link linkend="config-LSattribute-triggers">Voir la
225     section concernée</link></simpara>
226   </listitem>
227 </varlistentry>
228
229 </variablelist>  
230   &conf-LSattribute-LSattr_ldap;
231   &conf-LSattribute-LSattr_html;
232   
233   &conf-LSattribute-check-data;
234   &conf-LSattribute-validation;
235   &conf-LSattribute-triggers;
236   
237 </sect2>