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