Doc : Mise à jour de la doc de configuration suite à l'arriver de la classes LSsearch
[ldapsaisie.git] / doc / conf / LSobject / LSsearch.docbook
1 <sect2 id="config-LSobject-LSsearch">
2   <title>LSsearch</title>
3   <para>Cette section décrit la manière de paramétrer les recherches dans
4   l'annuaire pour un type d'&LSobject; donné.</para>
5
6 <para>La configuration des <emphasis>LSsearch</emphasis> se situe dans la 
7 configuration des &LSobjects;, dans la variable <varname>LSsearch</varname>
8 (<emphasis>$GLOBALS['LSobjects']['[nom du type d'LSobject]']['LSsearch']</emphasis>).
9 <programlisting>
10 <citetitle>Structure</citetitle>
11 <![CDATA[$GLOBALS['LSobjects']['[nom du type d'LSobject]']['LSsearch'] = array (
12   'attrs' => array(
13     'attr1',
14     'attr2',
15     ...
16   ),
17   'params' => array(
18     // Paramètres de la recherche
19     'pattern' => '[string]',
20     'sizelimit' => [integer],
21     'recursive' => [boolean],
22     'approx' => [boolean],
23     'withoutCache' => [boolean],
24     // Paramètres de tri
25     'sortBy' => [displayName|subDn],
26     'sortDirection' => [ASC|DESC],
27     'sortlimit' => [integer],
28     // Paramètre d'affichage
29     'displayFormat' => [LSformat],
30     'nbObjectsByPage' => [integer],
31     'nbPageLinkByPage' => [integer]
32   )
33 );]]>
34 </programlisting>
35
36 <variablelist>
37 <title>Paramètres de configuration</title>
38
39 <varlistentry>
40   <term>attrs</term>
41   <listitem>
42     <para>Tableau listant les attributs pouvant être utilisés dans les filtres
43     de recherche LDAP employés par &LdapSaisie;. Lorsqu'un motif de recherche est
44     passé par l'utilisateur, &LdapSaisie; composera un filtre LDAP à partir de
45     cette liste.</para>
46     <para>Lors d'une recherche non-approximative, le filtre de recherche sera
47     composé de la manière suivante :
48     <programlisting>(|(attr1=*motif*)(attr2=*motif*)...)</programlisting></para>
49     <para>Lors d'une recherche approximative, le filtre de recherche sera
50     composé de la manière suivante :
51     <programlisting>(|(attr1=~motif)(attr2~=motif)...)</programlisting></para>
52     <important><simpara>Ces filtres, une fois composés, sont insérés dans un autre,
53     filtrant en plus sur les <emphasis>ObjectClass</emphasis> du type
54     d'&LSobject; de la manière suivante :</simpara>
55     <programlisting><![CDATA[(& (&(objectclass=oc1)(objectclass=oc2)) (filtre) )]]></programlisting></important>
56   </listitem>
57 </varlistentry>
58
59 <varlistentry>
60   <term>params</term>
61   <listitem>
62     <para>Tableau des paramètres par défaut d'une recherche. Ce tableau contient
63 les paramètres qui seront utilisés pour initialisé une recherche. Ces paramètres
64 pourront être redéfini par l'utilisateur ou par l'application en fonction du
65 contexte dans lequel cette recherche est effectuée.</para>
66     
67     <variablelist>
68     <title>Paramètres de configuration</title>
69     
70 <varlistentry>
71   <term>pattern</term>
72   <listitem>
73     <simpara>Mot clé de la recherche.</simpara>
74   </listitem>
75 </varlistentry>
76
77 <varlistentry>
78   <term>sizelimit</term>
79   <listitem>
80     <simpara>Entier determinant le nombre maximum d'objet pouvant être retournés dans
81     une recherche.</simpara>
82   </listitem>
83 </varlistentry>
84
85 <varlistentry>
86   <term>recursive</term>
87   <listitem>
88     <simpara>Booléen déterminant si la recherche récursive est activée.</simpara>
89   </listitem>
90 </varlistentry>
91
92 <varlistentry>
93   <term>approx</term>
94   <listitem>
95     <simpara>Booléen déterminant si la recherche approximative est activée.</simpara>
96   </listitem>
97 </varlistentry>
98
99 <varlistentry>
100   <term>withoutCache</term>
101   <listitem>
102     <simpara>Booléen déterminant si le cache de recherche doit être utilisé.</simpara>
103   </listitem>
104 </varlistentry>
105
106 <varlistentry>
107   <term>sortBy</term>
108   <listitem>
109     <simpara>Mot clé déterminant sur quel valeur/colonne le résultat de recherche
110     sera trié.</simpara>
111     <simpara>Valeurs possibles : <literal>displayName</literal>, <literal>subDn</literal> ou  <literal>NULL</literal>.</simpara>
112   </listitem>
113 </varlistentry>
114
115 <varlistentry>
116   <term>sortDirection</term>
117   <listitem>
118     <simpara>Mot clé déterminant le sens du trie du résultat de la recherche.</simpara>
119     <simpara>Valeurs possibles : <literal>ASC</literal>, <literal>DESC</literal> ou  <literal>NULL</literal>.</simpara>
120   </listitem>
121 </varlistentry>
122
123 <varlistentry>
124   <term>sortlimit</term>
125   <listitem>
126     <simpara>Entier determinant le nombre maximum d'objet pouvant être triés dans
127     le résultat d'une recherche.</simpara>
128   </listitem>
129 </varlistentry>
130
131 <varlistentry>
132   <term>displayFormat</term>
133   <listitem>
134     <simpara>&LSformat; d'affichage du nom de l'objet dans le résultat de la recherche.</simpara>
135   </listitem>
136 </varlistentry>
137
138 <varlistentry>
139   <term>nbObjectsByPage</term>
140   <listitem>
141     <simpara>Entier déterminant le nombre d'objet maximum affichés dans une page
142     de résultat de la recherche.</simpara>
143   </listitem>
144 </varlistentry>
145
146 <varlistentry>
147   <term>nbPageLinkByPage</term>
148   <listitem>
149     <simpara>Entier déterminant le nombre maximum de liens vers d'autres pages
150     affichés sous le résultat de la recherche.</simpara>
151     <simpara>Par défaut : <literal>10</literal></simpara>
152   </listitem>
153 </varlistentry>
154
155     </variablelist>
156     
157   </listitem>
158 </varlistentry>
159
160 </variablelist>
161 </para>
162
163 </sect2>