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