LSattr_html :: select_list : Add sort feature (with sort and sortDirection parameters)
[ldapsaisie.git] / doc / conf / LSattribute / LSattr_html / LSattr_html_select_list.docbook
1 <sect4 id="config-LSattr_html_select_list">
2   <title>LSattr_html_select_list</title>
3   <para>Ce type est utilisé pour la gestion des attributs dont les valeurs font
4   partie d'une liste statique ou dynamique. Il est possible de lister des valeurs
5   statiques et également des références à d'autres &LSobjects;. La référence à
6   un objet correspond à une valeur clé, référente à un objet précis, qui peut être
7   soit la valeur d'un de ses attributs, soit son <emphasis>DN</emphasis>.</para>
8   
9   <programlisting linenumbering="unnumbered">
10 <citetitle>Structure</citetitle>...
11 <![CDATA['html_options' => array (
12    'possible_values' => array (
13      '[LSformat de la valeur clé]' => '[LSformat du nom d'affichage]',
14      ...
15      'OTHER_OBJECT' => array (
16        'object_type' => '[Type d'LSobject]',
17        'display_name_format' => '[LSformat du nom d'affichage des LSobjects]',
18        'value_attribute' => '[Nom de l'attribut clé]',
19        'filter' => '[Filtre de recherche des LSobject]',
20        'scope' => '[Scope de la recherche]',
21        'basedn' => '[Basedn de la recherche]'
22      )
23    ),
24    'sort' => [Booléen],
25    'sortDirection' => '[ASC|DESC]'
26 ),]]>
27 ...
28 </programlisting>
29
30 <variablelist>
31 <title>Paramètres de configuration</title>
32
33 <varlistentry>
34   <term>possible_values</term>
35   <listitem>
36     <para>Tableau associatif obligatoire contenant en valeur clé le &LSformat;
37     des valeurs clés prisent par l'attribut et en valeurs associées, le &LSformat;
38     des noms d'affichage de ces valeurs. Ces &LSformats; sont composés à partir des
39     valeurs de l'objet courant (attributs, dn, ...).</para>
40     
41     <para>Si la valeur clé est égale à <literal>OTHER_OBJECT</literal>, une liste
42     d'&LSobject; sera insérée dans la liste des valeurs possibles. La valeur
43     associée est alors un tableau associatif dont les valeurs clés sont les noms 
44     des paramètres de configuration de la recherche de ces &LSobjects; et les 
45     valeurs associées, les valeurs des paramètres.</para>
46     
47 <variablelist>
48   <varlistentry>
49     <term>object_type</term>
50     <listitem>
51       <simpara>Nom du type d'&LSobject; en référence.</simpara>
52     </listitem>
53   </varlistentry>
54 </variablelist>
55
56 <variablelist>
57   <varlistentry>
58     <term>display_name_format</term>
59     <listitem>
60       <simpara>&LSformat; du nom d'affichage des objets lors de leur sélection.</simpara>
61     </listitem>
62   </varlistentry>
63 </variablelist>
64
65 <variablelist>
66   <varlistentry>
67     <term>value_attribute</term>
68     <listitem>
69       <simpara>Nom de l'attribut des &LSobjects; en référence servant de valeur
70       clé et permettant de les identifier (Exemple : <emphasis>dn</emphasis> ou
71       <emphasis>uid</emphasis>).</simpara>
72     </listitem>
73   </varlistentry>
74 </variablelist>
75
76 <variablelist>
77   <varlistentry>
78     <term>filter</term>
79     <listitem>
80       <simpara>Filtre falcultatif de la recherche des LSobjets. Il sera dans tous
81       les cas agrémenté des valeurs des <emphasis>objectclass</emphasis> du type
82       d'&LSobject;.</simpara>
83     </listitem>
84   </varlistentry>
85 </variablelist>
86
87 <variablelist>
88   <varlistentry>
89     <term>scope</term>
90     <listitem>
91       <simpara>Scope falcultatif de la recherche des LSobjets.</simpara>
92     </listitem>
93   </varlistentry>
94 </variablelist>
95
96 <variablelist>
97   <varlistentry>
98     <term>basedn</term>
99     <listitem>
100       <simpara>Basedn falcultatif de la recherche des LSobjets.</simpara>
101     </listitem>
102   </varlistentry>
103 </variablelist>
104
105   </listitem>
106 </varlistentry>
107
108 </variablelist>
109
110 <variablelist>
111   <varlistentry>
112     <term>sort</term>
113     <listitem>
114       <simpara>Booléen définissant si les valeurs possibles doivent être
115       triées ou non (Vrai par défaut). Le trie est effectué sur les libellés
116       des valeurs possibles.</simpara>
117     </listitem>
118   </varlistentry>
119 </variablelist>
120
121 <varlistentry>
122   <term>sortDirection</term>
123   <listitem>
124     <simpara>Mot clé déterminant le sens du trie des valeurs possibles.</simpara>
125     <simpara>Valeurs possibles : <literal>ASC</literal> ou <literal>DESC</literal> (<literal>ASC</literal> par défaut).</simpara>
126   </listitem>
127 </varlistentry>
128 </sect4>