0fb33f1b83c863209ab5fd639ee5bb5be4c9c359
[ldapsaisie.git] / doc / conf / LSattribute / LSattr_html / LSattr_html_select_object.docbook
1 <sect4 id="config-LSattr_html_select_object">
2   <title>LSattr_html_select_object</title>
3   <para>Ce type est utilisé pour la gestion des attributs dont les valeurs sont
4   des références à d'autres &LSobjects;. Chaque référence à un objet correspond
5   à une valeur prise par l'attribut. Les valeurs clés référant à un &LSobject;
6   sont soit la valeur d'un de leurs attributs, soit leur <emphasis>DN</emphasis>.</para>
7   
8   <programlisting linenumbering="unnumbered">
9 <citetitle>Structure</citetitle>...
10 <![CDATA['html_options' => array (
11    selectable_object => array (
12      'object_type' => '[Type d'LSobject selectionnable]',
13      'display_name_format' => '[LSformat du nom d'affichage des LSobjects]',
14      'value_attribute' => '[Nom de l'attribut clé des LSobjects]'
15    ),
16    'ordered' => [Booléen],
17    'sort' => [Booléen],
18    'sortDirection' => '[ASC|DESC]'
19 ),]]>
20 ...
21 </programlisting>
22
23 <variablelist>
24 <title>Paramètres de configuration</title>
25
26 <varlistentry>
27   <term>selectable_object</term>
28   <listitem>
29     <simpara>Tableau associatif obligatoire contenant en valeur clé le nom des 
30     paramètres de configuration et dont les valeurs attachées sont les valeurs
31     des paramètres.</simpara>
32     
33     
34 <variablelist>
35   <varlistentry>
36     <term>object_type</term>
37     <listitem>
38       <simpara>Nom du type d'&LSobject; en référence.</simpara>
39     </listitem>
40   </varlistentry>
41
42   <varlistentry>
43     <term>display_name_format</term>
44     <listitem>
45       <simpara>&LSformat; du nom d'affichage des objets lors de leur sélection.</simpara>
46     </listitem>
47   </varlistentry>
48
49   <varlistentry>
50     <term>value_attribute</term>
51     <listitem>
52       <simpara>Nom de l'attribut des &LSobjects; en référence servant de valeur
53       clé et permettant de les identifier (Exemple : <emphasis>dn</emphasis> ou
54       <emphasis>uid</emphasis>).</simpara>
55     </listitem>
56   </varlistentry>
57
58   <varlistentry>
59     <term>filter</term>
60     <listitem>
61       <simpara>Filtre de recherche (facultatif) qui sera ajouter au filtre par défaut
62       lors de la sélection des objets.</simpara>
63     </listitem>
64   </varlistentry>
65 </variablelist>
66
67   </listitem>
68 </varlistentry>
69
70 <varlistentry>
71   <term>ordered</term>
72   <listitem>
73     <simpara>Booléen définissant si la liste des objets choisis doit être
74     ordonnable ou non (Faux par défaut). Cela aura pour effet d'activer une
75     fonctionnalité dynamique de l'interface permettant de remonter ou descendre
76     dans la liste les objets choisis.</simpara>
77     <note><simpara>Cette fonctionnalité désactive automatiquement le trie des
78     objets à l'affichage.</simpara></note>
79   </listitem>
80 </varlistentry>
81
82 <varlistentry>
83   <term>sort</term>
84   <listitem>
85     <simpara>Booléen définissant si la liste des objets choisis doit être
86     triée ou non (Vrai par défaut). Le trie est effectué sur les libellés
87     des objets choisis.</simpara>
88   </listitem>
89 </varlistentry>
90
91 <varlistentry>
92   <term>sortDirection</term>
93   <listitem>
94     <simpara>Mot clé déterminant le sens du trie des objets choisis.</simpara>
95     <simpara>Valeurs possibles : <literal>ASC</literal> ou <literal>DESC</literal> (<literal>ASC</literal> par défaut).</simpara>
96   </listitem>
97 </varlistentry>
98
99 </variablelist>
100   
101   
102 </sect4>