Doc / LSformElement : Added info about displayAttrName parameter
[ldapsaisie.git] / doc / conf / LSobject.docbook
1 <?xml version="1.0" encoding="UTF-8" ?>
2 <sect1 id='config-LSobject'>
3   <title>Configuration LSobject</title>
4   <para>
5     Cette partie décrit la manière de configurer les différents types de LSobjets
6     manipulés par &LdapSaisie;.
7   </para>
8   
9   <para>La configuration des &LSobjects; est stockée dans le dossier <emphasis>
10   /conf/LSobjects</emphasis>. Dans ce dossier, on retrouve un fichier par type 
11   d'&LSobject;, nommé de la manière suivante :
12   <programlisting>config.LSobjects.[nom du type d'LSobject].php</programlisting>
13   
14   Ce fichier contient la déclaration de la configuration du type d'&LSobject;
15   qui est stocké dans la variable globale 
16   <varname>$GLOBALS['LSobjects']['[nom du type d'LSobject]']</varname>.
17   </para>
18   
19   <programlisting linenumbering="unnumbered">
20   <citetitle>Structure</citetitle>...
21 <![CDATA[$GLOBALS['LSobjects']['[nom du type d'LSobject]'] = array (
22   'objectclass' => array(
23     'objetclass1',
24     'objetclass2',
25     ...
26   ),
27   'rdn' => 'attr1',
28
29   'LSaddons' => [LSaddon(s)],
30   
31   'container_dn' => 'ou=people',
32   'container_auto_create' => array(
33     // Information des configurations pour la création du conteneur du type d'LSobjet
34     // lors de la création nouveau subDn
35   ),
36
37   'disable_creation' => [boolean]',
38   
39   'before_modify' => 'function1',
40   'after_modify' => 'function2',
41   'after_create' => 'function3',
42   'after_delete' => 'function4',
43   
44   'label' => 'objet1',  
45   'display_name_format' => '[format]',
46   'displayAttrName' => '[booleen]',
47   
48   // LSrelation
49   'LSrelation' => array(
50     // Configuration des LSrelations entre ce type d'objet et les autres
51   ),
52   
53   // LSform
54   'LSform' => array (
55     // Configuration des formulaires de l'objet
56   ), // fin LSform
57   
58   // LSsearch
59   'LSsearch' => array (
60     // Configuration des recherches de l'objet
61   ), // fin LSsearch
62   
63   // Attributs
64   'attrs' => array (
65     // Configuration des attributs du type d'LSobjet
66   )
67 );]]>
68 ...
69 </programlisting>
70   
71 <variablelist>
72 <title>Paramètres de configuration</title>
73
74 <varlistentry>
75   <term>objectclass</term>
76   <listitem>
77     <simpara>La liste des <emphasis>objectclass</emphasis> des objets.</simpara>
78   </listitem>
79 </varlistentry>
80
81 <varlistentry>
82   <term>rdn</term>
83   <listitem>
84     <simpara>Nom de l'attribut correspondant au <emphasis>RDN</emphasis> des
85     objets LDAP.</simpara>
86   </listitem>
87 </varlistentry>
88
89 <varlistentry>
90   <term>LSaddons</term>
91   <listitem>
92     <simpara>LSaddon(s) dont le type d'objet dépend. Ce peut être un tableau de chaînes de
93     caractères ou une simpe chaîne de caractères correspondant au(x) nom(s) du/des LSaddon(s)
94     en dépendance.</simpara>
95   </listitem>
96 </varlistentry>
97
98 <varlistentry>
99   <term>container_dn</term>
100   <listitem>
101     <simpara>Elément pour construire le <emphasis>basedn</emphasis> de stockage
102     de ce type d'objet. Par exemple, si le <emphasis>basedn</emphasis> de 
103     l'annuaire est <literal>o=ls</literal> et que les objets
104     <emphasis>utilisateurs</emphasis> sont stockés dans la branche de l'annuaire
105     <literal>ou=people,o=ls</literal>, alors <parameter>container_dn</parameter>
106     devra valoir <literal>ou=people</literal>.</simpara>
107     <remark>Lorsque l'annuaire possède des &subDn;, les objets seront cherchés
108     dans le <emphasis>basedn</emphasis> résultant de la concaténation du paramètre
109     <parameter>container_dn</parameter>, d'une virgule et du 
110     <emphasis>basedn</emphasis> correspondant au &subDn; courant.</remark>
111   </listitem>
112 </varlistentry>
113
114 <varlistentry>
115   <term>container_auto_create</term>
116   <listitem>
117     <simpara>Tableau associatif contenant les paramètres de configuration
118     nécessaires à la création des <parameter>container_dn</parameter> dans les
119     nouveaux objets utilisés comme &subDn;. 
120     <link linkend="config-LSobject-container_auto_create">Voir la section
121     concernée</link>.</simpara>
122   </listitem>
123 </varlistentry>
124
125 <varlistentry>
126   <term>disable_creation</term>
127   <listitem>
128     <simpara>Booléen permetant de desactiver la creation de ce type d'objet de
129     manière globale.</simpara>
130   </listitem>
131 </varlistentry>
132
133 <varlistentry>
134   <term>before_modify</term>
135   <listitem>
136     <simpara>Chaîne de caractères correspondant au nom d'une fonction qui sera
137     exécutée avant la modification d'un objet.
138     <link linkend="config-LSobject-triggers">Voir la section concernée</link>.
139     </simpara>
140   </listitem>
141 </varlistentry>
142
143 <varlistentry>
144   <term>after_modify</term>
145   <listitem>
146     <simpara>Chaîne de caractères correspondant au nom d'une fonction qui sera
147     exécutée après la modification d'un objet.
148     <link linkend="config-LSobject-triggers">Voir la section concernée</link>.
149     </simpara>
150   </listitem>
151 </varlistentry>
152
153 <varlistentry>
154   <term>after_create</term>
155   <listitem>
156     <simpara>Chaîne de caractères correspondant au nom d'une fonction qui sera
157     exécutée après la création d'un objet.
158     <link linkend="config-LSobject-triggers">Voir la section concernée</link>.
159     </simpara>
160   </listitem>
161 </varlistentry>
162
163 <varlistentry>
164   <term>after_delete</term>
165   <listitem>
166     <simpara>Chaîne de caractères correspondant au nom d'une fonction qui sera
167     exécutée après la suppression d'un objet.
168     <link linkend="config-LSobject-triggers">Voir la section concernée</link>.
169     </simpara>
170   </listitem>
171 </varlistentry>
172
173 <varlistentry>
174   <term>label</term>
175   <listitem>
176     <simpara>Nom générique au pluriel qualifiant le type d'objet. Exemple : 
177     <emphasis>Utilisateurs</emphasis>.</simpara>
178   </listitem>
179 </varlistentry>
180
181 <varlistentry>
182   <term>display_name_format</term>
183   <listitem>
184     <simpara><link linkend="config-LSformat">Format paramètrable</link> du nom
185     des objets composés à partir des valeurs d'affichage des attributs de l'objet.
186     </simpara>
187   </listitem>
188 </varlistentry>
189
190 <varlistentry>
191   <term>displayAttrName</term>
192   <listitem>
193     <simpara>Booléen définissant si le nom des attributs doit être affiché en
194     préfixe de leur message d'aide (paramètre <parameter>help_info</parameter>).</simpara>
195   </listitem>
196 </varlistentry>
197
198 <varlistentry>
199   <term>LSrelation</term>
200   <listitem>
201     <simpara>Tableau associatif contenant les paramètres de configuration
202     des &LSrelations;. <link linkend="config-LSobject-LSrelation">Voir la section
203     concernée</link>.</simpara>
204   </listitem>
205 </varlistentry>
206
207 <varlistentry>
208   <term>LSform</term>
209   <listitem>
210     <simpara>Tableau associatif contenant les paramètres de configuration
211     des &LSforms; des &LSobjects;. <link linkend="config-LSobject-LSform">Voir
212     la section concernée</link>.</simpara>
213   </listitem>
214 </varlistentry>
215
216 <varlistentry>
217   <term>LSsearch</term>
218   <listitem>
219     <simpara>Tableau associatif contenant les paramètres de configuration
220     des recherches de &LSobject; de ce type dans l'annuaire.
221     <link linkend="config-LSobject-LSsearch">Voir la section concernée</link>.
222     </simpara>
223   </listitem>
224 </varlistentry>
225
226 <varlistentry>
227   <term>filter</term>
228   <listitem>
229     <simpara>Filtre de recherche LDAP applicable à tout les objets de ce type et
230     qui sera utilisé lors de chaque recherche de ce type d'objet.
231     </simpara>
232   </listitem>
233 </varlistentry>
234
235 <varlistentry>
236   <term>attrs</term>
237   <listitem>
238     <simpara>Tableau associatif contenant les paramètres de configuration
239     des attributs des objets. <link linkend="config-LSattribute">Voir
240     la section concernée</link>.</simpara>
241   </listitem>
242 </varlistentry>
243
244 </variablelist>
245
246   &conf-LSattribute;
247   &conf-LSobject-container_auto_create;
248   &conf-LSobject-triggers;
249   &conf-LSobject-LSrelation;
250   &conf-LSobject-LSform;
251   &conf-LSobject-LSsearch;
252
253 </sect1>