a0abe28412a64bfb8556121b1cde42a6af99cb1c
[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        'values_attribute' => '[Nom de l'attribut clé multi-valeur]',
20        'filter' => '[Filtre de recherche des LSobject]',
21        'scope' => '[Scope de la recherche]',
22        'basedn' => '[Basedn de la recherche]'
23      ),
24      array (
25        'label' => '[LSformat du nom du groupe de valeurs]',
26        'possible_values' => array (
27          '[LSformat de la valeur clé]' => '[LSformat du nom d'affichage]',
28          ...
29          'OTHER_OBJECT' => array (
30            ...
31          )
32        )
33      )
34    ),
35    'sort' => [Booléen],
36    'sortDirection' => '[ASC|DESC]'
37 ),]]>
38 ...
39 </programlisting>
40
41 <variablelist>
42 <title>Paramètres de configuration</title>
43
44 <varlistentry>
45   <term>possible_values</term>
46   <listitem>
47     <para>Tableau associatif obligatoire contenant en valeur clé le &LSformat;
48     des valeurs clés prisent par l'attribut et en valeurs associées, le &LSformat;
49     des noms d'affichage de ces valeurs. Ces &LSformats; sont composés à partir des
50     valeurs de l'objet courant (attributs, dn, ...).</para>
51     
52     <para>Si la valeur clé est égale à <literal>OTHER_OBJECT</literal>, une liste
53     d'&LSobject; sera insérée dans la liste des valeurs possibles. La valeur
54     associée est alors un tableau associatif dont les valeurs clés sont les noms 
55     des paramètres de configuration de la recherche de ces &LSobjects; et les 
56     valeurs associées, les valeurs des paramètres.</para>
57
58     <para>Il est possible de regrouper des valeurs de l'attribut en plaçant leur
59     déclaration dans un sous-tableau. Ce sous-tableau devra contenir la clé
60     <literal>label</literal> dont la valeur associé sera le &LSformat; du nom du groupe
61     de valeurs. Ce &LSformat; est composé à partir des valeurs de l'objet courant
62     (attributs, dn, ...). Une seconde clé <literal>possible_values</literal> regroupera
63     les valeurs possibles du groupe. Comme pour le tableau principal, la clé <literal>
64     OTHER_OBJECT</literal> permet d'imcorporer une liste d'&LSobject;.</para>
65 <variablelist>
66   <varlistentry>
67     <term>object_type</term>
68     <listitem>
69       <simpara>Nom du type d'&LSobject; en référence.</simpara>
70     </listitem>
71   </varlistentry>
72
73   <varlistentry>
74     <term>display_name_format</term>
75     <listitem>
76       <simpara>&LSformat; du nom d'affichage des objets lors de leur sélection.</simpara>
77     </listitem>
78   </varlistentry>
79
80   <varlistentry>
81     <term>value_attribute</term>
82     <listitem>
83       <simpara>Nom de l'attribut des &LSobjects; en référence servant de valeur
84       clé et permettant de les identifier (Exemple : <emphasis>dn</emphasis> ou
85       <emphasis>uid</emphasis>).</simpara>
86     </listitem>
87   </varlistentry>
88
89   <varlistentry>
90     <term>values_attribute</term>
91     <listitem>
92       <simpara>Nom de l'attribut des &LSobjects; en référence servant de catalogue de
93       valeurs. Dans ce mode, la valeur n'a pas de label et est affichée directement
94       dans l'interface. Ce paramètre peut-être utilisé en complément ou non du paramètre
95       <emphasis>value_attribute</emphasis>.</simpara>
96     </listitem>
97   </varlistentry>
98
99   <varlistentry>
100     <term>filter</term>
101     <listitem>
102       <simpara>Filtre falcultatif de la recherche des LSobjets. Il sera dans tous
103       les cas agrémenté des valeurs des <emphasis>objectclass</emphasis> du type
104       d'&LSobject;.</simpara>
105     </listitem>
106   </varlistentry>
107
108   <varlistentry>
109     <term>scope</term>
110     <listitem>
111       <simpara>Scope falcultatif de la recherche des LSobjets.</simpara>
112     </listitem>
113   </varlistentry>
114
115   <varlistentry>
116     <term>basedn</term>
117     <listitem>
118       <simpara>Basedn falcultatif de la recherche des LSobjets.</simpara>
119     </listitem>
120   </varlistentry>
121 </variablelist>
122
123   </listitem>
124 </varlistentry>
125
126
127 <varlistentry>
128   <term>sort</term>
129   <listitem>
130     <simpara>Booléen définissant si les valeurs possibles doivent être
131     triées ou non (Vrai par défaut). Le trie est effectué sur les libellés
132     des valeurs possibles.</simpara>
133   </listitem>
134 </varlistentry>
135
136 <varlistentry>
137   <term>sortDirection</term>
138   <listitem>
139     <simpara>Mot clé déterminant le sens du trie des valeurs possibles.</simpara>
140     <simpara>Valeurs possibles : <literal>ASC</literal> ou <literal>DESC</literal> (<literal>ASC</literal> par défaut).</simpara>
141   </listitem>
142 </varlistentry>
143 </variablelist>
144 </sect4>