5693dc3b90945ca7c2da9a019f5142ece1fec1de
[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   'predefinedFilters' => array(
34     'filter1' => 'label filter1',
35     'filter2' => 'label filter2'
36   )
37 );]]>
38 </programlisting>
39
40 <variablelist>
41 <title>Paramètres de configuration</title>
42
43 <varlistentry>
44   <term>attrs</term>
45   <listitem>
46     <para>Tableau listant les attributs pouvant être utilisés dans les filtres
47     de recherche LDAP employés par &LdapSaisie;. Lorsqu'un motif de recherche est
48     passé par l'utilisateur, &LdapSaisie; composera un filtre LDAP à partir de
49     cette liste.</para>
50     <para>Lors d'une recherche non-approximative, le filtre de recherche sera
51     composé de la manière suivante :
52     <programlisting>(|(attr1=*motif*)(attr2=*motif*)...)</programlisting></para>
53     <para>Lors d'une recherche approximative, le filtre de recherche sera
54     composé de la manière suivante :
55     <programlisting>(|(attr1=~motif)(attr2~=motif)...)</programlisting></para>
56     <important><simpara>Ces filtres, une fois composés, sont insérés dans un autre,
57     filtrant en plus sur les <emphasis>ObjectClass</emphasis> du type
58     d'&LSobject; de la manière suivante :</simpara>
59     <programlisting><![CDATA[(& (&(objectclass=oc1)(objectclass=oc2)) (filtre) )]]></programlisting></important>
60   </listitem>
61 </varlistentry>
62
63 <varlistentry>
64   <term>params</term>
65   <listitem>
66     <para>Tableau des paramètres par défaut d'une recherche. Ce tableau contient
67 les paramètres qui seront utilisés pour initialisé une recherche. Ces paramètres
68 pourront être redéfini par l'utilisateur ou par l'application en fonction du
69 contexte dans lequel cette recherche est effectuée.</para>
70     
71     <variablelist>
72     <title>Paramètres de configuration</title>
73     
74 <varlistentry>
75   <term>pattern</term>
76   <listitem>
77     <simpara>Mot clé de la recherche.</simpara>
78   </listitem>
79 </varlistentry>
80
81 <varlistentry>
82   <term>sizelimit</term>
83   <listitem>
84     <simpara>Entier determinant le nombre maximum d'objet pouvant être retournés dans
85     une recherche.</simpara>
86   </listitem>
87 </varlistentry>
88
89 <varlistentry>
90   <term>recursive</term>
91   <listitem>
92     <simpara>Booléen déterminant si la recherche récursive est activée.</simpara>
93   </listitem>
94 </varlistentry>
95
96 <varlistentry>
97   <term>approx</term>
98   <listitem>
99     <simpara>Booléen déterminant si la recherche approximative est activée.</simpara>
100   </listitem>
101 </varlistentry>
102
103 <varlistentry>
104   <term>withoutCache</term>
105   <listitem>
106     <simpara>Booléen déterminant si le cache de recherche doit être utilisé.</simpara>
107   </listitem>
108 </varlistentry>
109
110 <varlistentry>
111   <term>sortBy</term>
112   <listitem>
113     <simpara>Mot clé déterminant sur quel valeur/colonne le résultat de recherche
114     sera trié.</simpara>
115     <simpara>Valeurs possibles : <literal>displayName</literal>, <literal>subDn</literal> ou  <literal>NULL</literal>.</simpara>
116   </listitem>
117 </varlistentry>
118
119 <varlistentry>
120   <term>sortDirection</term>
121   <listitem>
122     <simpara>Mot clé déterminant le sens du trie du résultat de la recherche.</simpara>
123     <simpara>Valeurs possibles : <literal>ASC</literal>, <literal>DESC</literal> ou  <literal>NULL</literal>.</simpara>
124   </listitem>
125 </varlistentry>
126
127 <varlistentry>
128   <term>sortlimit</term>
129   <listitem>
130     <simpara>Entier determinant le nombre maximum d'objet pouvant être triés dans
131     le résultat d'une recherche.</simpara>
132   </listitem>
133 </varlistentry>
134
135 <varlistentry>
136   <term>displayFormat</term>
137   <listitem>
138     <simpara>&LSformat; d'affichage du nom de l'objet dans le résultat de la recherche.</simpara>
139   </listitem>
140 </varlistentry>
141
142 <varlistentry>
143   <term>nbObjectsByPage</term>
144   <listitem>
145     <simpara>Entier déterminant le nombre d'objet maximum affichés dans une page
146     de résultat de la recherche.</simpara>
147   </listitem>
148 </varlistentry>
149
150 <varlistentry>
151   <term>nbPageLinkByPage</term>
152   <listitem>
153     <simpara>Entier déterminant le nombre maximum de liens vers d'autres pages
154     affichés sous le résultat de la recherche.</simpara>
155     <simpara>Par défaut : <literal>10</literal></simpara>
156   </listitem>
157 </varlistentry>
158
159     </variablelist>
160     
161   </listitem>
162 </varlistentry>
163
164 <varlistentry>
165   <term>predefinedFilters</term>
166   <listitem>
167     <para>Tableau associatif contenant des filtres prédéfinis pour la recherche.
168     Les clés sont les filtres au format LDAP et les valeurs sont les labels associés.</para>
169   </listitem>
170 </varlistentry> 
171
172 </variablelist>
173 </para>
174
175 </sect2>