60496e7d29e356792d058020e212ba17a57552e4
[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   'container_dn' => 'ou=people',
30   'container_auto_create' => array(
31     // Information des configurations pour la création du conteneur du type d'LSobjet
32     // lors de la création nouveau subDn
33   ),
34   
35   'before_modify' => 'function1',
36   'after_modify' => 'function2',
37   'after_create' => 'function3',
38   'after_delete' => 'function4',
39   
40   'label' => 'objet1',
41   
42   'display_name_format' => '[format]',
43   'orderby' => 'displayName',  // Valeurs possibles : 'displayName' ou 'subDn'
44   
45   // LSrelation
46   'LSrelation' => array(
47     // Configuration des LSrelations entre ce type d'objet et les autres
48   ),
49   
50   // LSform
51   'LSform' => array (
52     // Configuration des formulaires de l'objet
53   ), // fin LSform
54   
55   // LSsearch
56   'LSsearch' => array (
57     // Configuration des recherches de l'objet
58   ), // fin LSsearch
59   
60   // Attributs
61   'attrs' => array (
62     // Configuration des attributs du type d'LSobjet
63   )
64 );]]>
65 ...
66 </programlisting>
67   
68 <variablelist>
69 <title>Paramètres de configuration</title>
70
71 <varlistentry>
72   <term>objectclass</term>
73   <listitem>
74     <simpara>La liste des <emphasis>objectclass</emphasis> des objets.</simpara>
75   </listitem>
76 </varlistentry>
77
78 <varlistentry>
79   <term>rdn</term>
80   <listitem>
81     <simpara>Nom de l'attribut correspondant au <emphasis>RDN</emphasis> des
82     objets LDAP.</simpara>
83   </listitem>
84 </varlistentry>
85
86 <varlistentry>
87   <term>container_dn</term>
88   <listitem>
89     <simpara>Elément pour construire le <emphasis>basedn</emphasis> de stockage
90     de ce type d'objet. Par exemple, si le <emphasis>basedn</emphasis> de 
91     l'annuaire est <literal>o=ls</literal> et que les objets
92     <emphasis>utilisateurs</emphasis> sont stockés dans la branche de l'annuaire
93     <literal>ou=people,o=ls</literal>, alors <parameter>container_dn</parameter>
94     devra valoir <literal>ou=people</literal>.</simpara>
95     <remark>Lorsque l'annuaire possède des &subDn;, les objets seront cherchés
96     dans le <emphasis>basedn</emphasis> résultant de la concaténation du paramètre
97     <parameter>container_dn</parameter>, d'une virgule et du 
98     <emphasis>basedn</emphasis> correspondant au &subDn; courant.</remark>
99   </listitem>
100 </varlistentry>
101
102 <varlistentry>
103   <term>container_auto_create</term>
104   <listitem>
105     <simpara>Tableau associatif contenant les paramètres de configuration
106     nécessaires à la création des <parameter>container_dn</parameter> dans les
107     nouveaux objets utilisés comme &subDn;. 
108     <link linkend="config-LSobject-container_auto_create">Voir la section
109     concernée</link>.</simpara>
110   </listitem>
111 </varlistentry>
112
113 <varlistentry>
114   <term>before_modify</term>
115   <listitem>
116     <simpara>Chaîne de caractères correspondant au nom d'une fonction qui sera
117     exécutée avant la modification d'un objet.
118     <link linkend="config-LSobject-triggers">Voir la section concernée</link>.
119     </simpara>
120   </listitem>
121 </varlistentry>
122
123 <varlistentry>
124   <term>after_modify</term>
125   <listitem>
126     <simpara>Chaîne de caractères correspondant au nom d'une fonction qui sera
127     exécutée après la modification d'un objet.
128     <link linkend="config-LSobject-triggers">Voir la section concernée</link>.
129     </simpara>
130   </listitem>
131 </varlistentry>
132
133 <varlistentry>
134   <term>after_create</term>
135   <listitem>
136     <simpara>Chaîne de caractères correspondant au nom d'une fonction qui sera
137     exécutée après la création 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_delete</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 suppression 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>label</term>
155   <listitem>
156     <simpara>Nom générique au pluriel qualifiant le type d'objet. Exemple : 
157     <emphasis>Utilisateurs</emphasis>.</simpara>
158   </listitem>
159 </varlistentry>
160
161 <varlistentry>
162   <term>display_name_format</term>
163   <listitem>
164     <simpara><link linkend="config-LSformat">Format paramètrable</link> du nom
165     des objets composés à partir des valeurs d'affichage des attributs de l'objet.
166     </simpara>
167   </listitem>
168 </varlistentry>
169
170 <varlistentry>
171   <term>orderby</term>
172   <listitem>
173     <simpara>Paramétrage du tri par défaut des objets lors de l'affiche du
174     résultat d'une recherche.</simpara>
175     <simpara>Valeurs possibles : <literal>displayName</literal> ou <literal>subDn</literal></simpara>
176     <simpara>(Paramètre facultatif)</simpara>
177   </listitem>
178 </varlistentry>
179
180 <varlistentry>
181   <term>LSrelation</term>
182   <listitem>
183     <simpara>Tableau associatif contenant les paramètres de configuration
184     des &LSrelations;. <link linkend="config-LSobject-LSrelation">Voir la section
185     concernée</link>.</simpara>
186   </listitem>
187 </varlistentry>
188
189 <varlistentry>
190   <term>LSform</term>
191   <listitem>
192     <simpara>Tableau associatif contenant les paramètres de configuration
193     des &LSforms; des &LSobjects;. <link linkend="config-LSobject-LSform">Voir
194     la section concernée</link>.</simpara>
195   </listitem>
196 </varlistentry>
197
198 <varlistentry>
199   <term>LSsearch</term>
200   <listitem>
201     <simpara>Tableau associatif contenant les paramètres de configuration
202     des recherches de &LSobject; de ce type dans l'annuaire.
203     <link linkend="config-LSobject-LSsearch">Voir la section concernée</link>.
204     </simpara>
205   </listitem>
206 </varlistentry>
207
208 <varlistentry>
209   <term>filter</term>
210   <listitem>
211     <simpara>Filtre de recherche LDAP applicable à tout les objets de ce type et
212     qui sera utilisé lors de chaque recherche de ce type d'objet.
213     </simpara>
214   </listitem>
215 </varlistentry>
216
217 <varlistentry>
218   <term>attrs</term>
219   <listitem>
220     <simpara>Tableau associatif contenant les paramètres de configuration
221     des attributs des objets. <link linkend="config-LSattribute">Voir
222     la section concernée</link>.</simpara>
223   </listitem>
224 </varlistentry>
225
226 </variablelist>
227
228   &conf-LSattribute;
229   &conf-LSobject-container_auto_create;
230   &conf-LSobject-triggers;
231   &conf-LSobject-LSrelation;
232   &conf-LSobject-LSform;
233   &conf-LSobject-LSsearch;
234
235 </sect1>