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