3a2eb17adf6acfe98f443fe5d477b2da2ea0c5d2
[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   'recursive' => [booléen]
18 );]]>
19 </programlisting>
20
21 <variablelist>
22 <title>Paramètres de configuration</title>
23
24 <varlistentry>
25   <term>attrs</term>
26   <listitem>
27     <para>Tableau listant les attributs pouvant être utilisés dans les filtres
28     de recherche LDAP employés par &LdapSaisie;. Lorsqu'un motif de recherche est
29     passé par l'utilisateur, &LdapSaisie; composera un filtre LDAP à partir de
30     cette liste.</para>
31     <para>Lors d'une recherche non-approximative, le filtre de recherche sera
32     composé de la manière suivante :
33     <programlisting>(|(attr1=*motif*)(attr2=*motif*)...)</programlisting></para>
34     <para>Lors d'une recherche approximative, le filtre de recherche sera
35     composé de la manière suivante :
36     <programlisting>(|(attr1=~motif)(attr2~=motif)...)</programlisting></para>
37     <important><simpara>Ces filtres, une fois composés, sont insérés dans un autre,
38     filtrant en plus sur les <emphasis>ObjectClass</emphasis> du type
39     d'&LSobject; de la manière suivante :</simpara>
40     <programlisting><![CDATA[(& (&(objectclass=oc1)(objectclass=oc2)) (filtre) )]]></programlisting></important>
41   </listitem>
42 </varlistentry>
43
44 <varlistentry>
45   <term>recursive</term>
46   <listitem>
47     <para>Booléen déterminant si la recherche récursive est activée ou non par
48     défaut pour ce type d'LSobject.</para>
49   </listitem>
50 </varlistentry>
51
52 </variablelist>
53 </para>
54
55 </sect2>