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