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