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