LSattr_html :: select_list : Add sort feature (with sort and sortDirection parameters)
[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   //Custom Actions
49   'customActions' => array (
50     // Configuration des customActions pour ce type d'objet
51   ),
52   
53   // LSrelation
54   'LSrelation' => array(
55     // Configuration des LSrelations entre ce type d'objet et les autres
56   ),
57   
58   // LSform
59   'LSform' => array (
60     // Configuration des formulaires de l'objet
61   ), // fin LSform
62   
63   // LSsearch
64   'LSsearch' => array (
65     // Configuration des recherches de l'objet
66   ), // fin LSsearch
67   
68   // Attributs
69   'attrs' => array (
70     // Configuration des attributs du type d'LSobjet
71   )
72 );]]>
73 ...
74 </programlisting>
75   
76 <variablelist>
77 <title>Paramètres de configuration</title>
78
79 <varlistentry>
80   <term>objectclass</term>
81   <listitem>
82     <simpara>La liste des <emphasis>objectclass</emphasis> des objets.</simpara>
83   </listitem>
84 </varlistentry>
85
86 <varlistentry>
87   <term>rdn</term>
88   <listitem>
89     <simpara>Nom de l'attribut correspondant au <emphasis>RDN</emphasis> des
90     objets LDAP.</simpara>
91   </listitem>
92 </varlistentry>
93
94 <varlistentry>
95   <term>LSaddons</term>
96   <listitem>
97     <simpara>LSaddon(s) dont le type d'objet dépend. Ce peut être un tableau de chaînes de
98     caractères ou une simpe chaîne de caractères correspondant au(x) nom(s) du/des LSaddon(s)
99     en dépendance.</simpara>
100   </listitem>
101 </varlistentry>
102
103 <varlistentry>
104   <term>container_dn</term>
105   <listitem>
106     <simpara>Elément pour construire le <emphasis>basedn</emphasis> de stockage
107     de ce type d'objet. Par exemple, si le <emphasis>basedn</emphasis> de 
108     l'annuaire est <literal>o=ls</literal> et que les objets
109     <emphasis>utilisateurs</emphasis> sont stockés dans la branche de l'annuaire
110     <literal>ou=people,o=ls</literal>, alors <parameter>container_dn</parameter>
111     devra valoir <literal>ou=people</literal>.</simpara>
112     <remark>Lorsque l'annuaire possède des &subDn;, les objets seront cherchés
113     dans le <emphasis>basedn</emphasis> résultant de la concaténation du paramètre
114     <parameter>container_dn</parameter>, d'une virgule et du 
115     <emphasis>basedn</emphasis> correspondant au &subDn; courant.</remark>
116   </listitem>
117 </varlistentry>
118
119 <varlistentry>
120   <term>container_auto_create</term>
121   <listitem>
122     <simpara>Tableau associatif contenant les paramètres de configuration
123     nécessaires à la création des <parameter>container_dn</parameter> dans les
124     nouveaux objets utilisés comme &subDn;. 
125     <link linkend="config-LSobject-container_auto_create">Voir la section
126     concernée</link>.</simpara>
127   </listitem>
128 </varlistentry>
129
130 <varlistentry>
131   <term>disable_creation</term>
132   <listitem>
133     <simpara>Booléen permetant de desactiver la creation de ce type d'objet de
134     manière globale.</simpara>
135   </listitem>
136 </varlistentry>
137
138 <varlistentry>
139   <term>before_modify</term>
140   <listitem>
141     <simpara>Chaîne de caractères correspondant au nom d'une fonction qui sera
142     exécutée avant la modification d'un objet.
143     <link linkend="config-LSobject-triggers">Voir la section concernée</link>.
144     </simpara>
145   </listitem>
146 </varlistentry>
147
148 <varlistentry>
149   <term>after_modify</term>
150   <listitem>
151     <simpara>Chaîne de caractères correspondant au nom d'une fonction qui sera
152     exécutée après la modification d'un objet.
153     <link linkend="config-LSobject-triggers">Voir la section concernée</link>.
154     </simpara>
155   </listitem>
156 </varlistentry>
157
158 <varlistentry>
159   <term>after_create</term>
160   <listitem>
161     <simpara>Chaîne de caractères correspondant au nom d'une fonction qui sera
162     exécutée après la création d'un objet.
163     <link linkend="config-LSobject-triggers">Voir la section concernée</link>.
164     </simpara>
165   </listitem>
166 </varlistentry>
167
168 <varlistentry>
169   <term>after_delete</term>
170   <listitem>
171     <simpara>Chaîne de caractères correspondant au nom d'une fonction qui sera
172     exécutée après la suppression d'un objet.
173     <link linkend="config-LSobject-triggers">Voir la section concernée</link>.
174     </simpara>
175   </listitem>
176 </varlistentry>
177
178 <varlistentry>
179   <term>label</term>
180   <listitem>
181     <simpara>Nom générique au pluriel qualifiant le type d'objet. Exemple : 
182     <emphasis>Utilisateurs</emphasis>.</simpara>
183   </listitem>
184 </varlistentry>
185
186 <varlistentry>
187   <term>display_name_format</term>
188   <listitem>
189     <simpara><link linkend="config-LSformat">Format paramètrable</link> du nom
190     des objets composés à partir des valeurs d'affichage des attributs de l'objet.
191     </simpara>
192   </listitem>
193 </varlistentry>
194
195 <varlistentry>
196   <term>displayAttrName</term>
197   <listitem>
198     <simpara>Booléen définissant si le nom des attributs doit être affiché en
199     préfixe de leur message d'aide (paramètre <parameter>help_info</parameter>).</simpara>
200   </listitem>
201 </varlistentry>
202
203 <varlistentry>
204   <term>customActions</term>
205   <listitem>
206     <simpara>Tableau associatif contenant les paramètres de configuration
207     des &customActions;. <link linkend="config-LSobject-customActions">Voir la section
208     concernée</link>.</simpara>
209   </listitem>
210 </varlistentry>
211
212 <varlistentry>
213   <term>LSrelation</term>
214   <listitem>
215     <simpara>Tableau associatif contenant les paramètres de configuration
216     des &LSrelations;. <link linkend="config-LSobject-LSrelation">Voir la section
217     concernée</link>.</simpara>
218   </listitem>
219 </varlistentry>
220
221 <varlistentry>
222   <term>LSform</term>
223   <listitem>
224     <simpara>Tableau associatif contenant les paramètres de configuration
225     des &LSforms; des &LSobjects;. <link linkend="config-LSobject-LSform">Voir
226     la section concernée</link>.</simpara>
227   </listitem>
228 </varlistentry>
229
230 <varlistentry>
231   <term>LSsearch</term>
232   <listitem>
233     <simpara>Tableau associatif contenant les paramètres de configuration
234     des recherches de &LSobject; de ce type dans l'annuaire.
235     <link linkend="config-LSobject-LSsearch">Voir la section concernée</link>.
236     </simpara>
237   </listitem>
238 </varlistentry>
239
240 <varlistentry>
241   <term>filter</term>
242   <listitem>
243     <simpara>Filtre de recherche LDAP applicable à tout les objets de ce type et
244     qui sera utilisé lors de chaque recherche de ce type d'objet.
245     </simpara>
246   </listitem>
247 </varlistentry>
248
249 <varlistentry>
250   <term>attrs</term>
251   <listitem>
252     <simpara>Tableau associatif contenant les paramètres de configuration
253     des attributs des objets. <link linkend="config-LSattribute">Voir
254     la section concernée</link>.</simpara>
255   </listitem>
256 </varlistentry>
257
258 </variablelist>
259
260   &conf-LSattribute;
261   &conf-LSobject-container_auto_create;
262   &conf-LSobject-triggers;
263   &conf-LSobject-customActions;
264   &conf-LSobject-LSrelation;
265   &conf-LSobject-LSform;
266   &conf-LSobject-LSsearch;
267
268 </sect1>