LSsearch : Added searchLSformat and approxLSformat parameter for searched attributes
[ldapsaisie.git] / doc / conf / LSobject / LSsearch.docbook
index 3f776b8..728a219 100644 (file)
@@ -13,6 +13,11 @@ configuration des &LSobjects;, dans la variable <varname>LSsearch</varname>
     'attr1',
     'attr2',
     ...
+    'attr3' => array(
+      'searchLSformat' => '[LSformat]',
+      'approxLSformat' => '[LSformat]',
+    ),
+    ...
   ),
   'params' => array(
     // Paramètres de la recherche
@@ -29,6 +34,10 @@ configuration des &LSobjects;, dans la variable <varname>LSsearch</varname>
     'displayFormat' => [LSformat],
     'nbObjectsByPage' => [integer],
     'nbPageLinkByPage' => [integer]
+  ),
+  'predefinedFilters' => array(
+    'filter1' => 'label filter1',
+    'filter2' => 'label filter2'
   )
 );]]>
 </programlisting>
@@ -44,15 +53,58 @@ configuration des &LSobjects;, dans la variable <varname>LSsearch</varname>
     passé par l'utilisateur, &LdapSaisie; composera un filtre LDAP à partir de
     cette liste.</para>
     <para>Lors d'une recherche non-approximative, le filtre de recherche sera
-    composé de la manière suivante :
+    composé (par défaut) de la manière suivante :
     <programlisting>(|(attr1=*motif*)(attr2=*motif*)...)</programlisting></para>
     <para>Lors d'une recherche approximative, le filtre de recherche sera
-    composé de la manière suivante :
+    composé (par défaut) de la manière suivante :
     <programlisting>(|(attr1=~motif)(attr2~=motif)...)</programlisting></para>
+    <para>Il est également possible de paramétrer la manière dont sera composé le filtre
+    de recherche attribut par attribut à l'aide des paramètres <emphasis>searchLSformat</emphasis>
+    et <emphasis>approxLSformat</emphasis>.</para>
     <important><simpara>Ces filtres, une fois composés, sont insérés dans un autre,
     filtrant en plus sur les <emphasis>ObjectClass</emphasis> du type
     d'&LSobject; de la manière suivante :</simpara>
     <programlisting><![CDATA[(& (&(objectclass=oc1)(objectclass=oc2)) (filtre) )]]></programlisting></important>
+
+    <variablelist>
+    <title>Paramètres des attributs</title>
+
+<varlistentry>
+  <term>searchLSformat</term>
+  <listitem>
+    <para>Ce paramètre est un &LSformat; permettant de définir, attribut par attribut, comment le
+    filtre de recherche LDAP est composé à partir d'un motif de recherche et en cas de recherche
+    non-approximative.</para>
+    <para>Ce &LSformat; est composé à l'aide des éléments <emphasis>name</emphasis>, le nom de
+    l'attribut et <emphasis>pattern</emphasis>, le motif de recherche.
+    <programlisting>
+    <citetitle>Exemple</citetitle>
+<![CDATA[(%{name}=%{pattern})]]>
+    </programlisting></para>
+    <important><simpara>Le filtre déduit doit obligatoirement commencer par <emphasis>(</emphasis> et
+    se terminer par <emphasis>)</emphasis>.</simpara></important>
+  </listitem>
+</varlistentry>
+
+<varlistentry>
+  <term>approxLSformat</term>
+  <listitem>
+    <para>Ce paramètre est un &LSformat; permettant de définir, attribut par attribut, comment le
+    filtre de recherche LDAP est composé à partir d'un motif de recherche et en cas de recherche
+    approximative.</para>
+    <para>Ce &LSformat; est composé à l'aide des éléments <emphasis>name</emphasis>, le nom de
+    l'attribut et <emphasis>pattern</emphasis>, le motif de recherche.
+    <programlisting>
+    <citetitle>Exemple</citetitle>
+<![CDATA[(%{name}=~%{pattern})]]>
+    </programlisting></para>
+    <important><simpara>Le filtre déduit doit obligatoirement commencer par <emphasis>(</emphasis> et
+    se terminer par <emphasis>)</emphasis>.</simpara></important>
+  </listitem>
+</varlistentry>
+
+    </variablelist>
+
   </listitem>
 </varlistentry>
 
@@ -157,6 +209,14 @@ contexte dans lequel cette recherche est effectuée.</para>
   </listitem>
 </varlistentry>
 
+<varlistentry>
+  <term>predefinedFilters</term>
+  <listitem>
+    <para>Tableau associatif contenant des filtres prédéfinis pour la recherche.
+    Les clés sont les filtres au format LDAP et les valeurs sont les labels associés.</para>
+  </listitem>
+</varlistentry> 
+
 </variablelist>
 </para>