LSattr_html :: select_list / select_object : add parameter to handle onlyAccessible...
[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      'onlyAccessible' => '[Booléen]'
16    ),
17    'ordered' => [Booléen],
18    'sort' => [Booléen],
19    'sortDirection' => '[ASC|DESC]'
20 ),]]>
21 ...
22 </programlisting>
23
24 <variablelist>
25 <title>Paramètres de configuration</title>
26
27 <varlistentry>
28   <term>selectable_object</term>
29   <listitem>
30     <simpara>Tableau associatif obligatoire contenant en valeur clé le nom des 
31     paramètres de configuration et dont les valeurs attachées sont les valeurs
32     des paramètres.</simpara>
33     
34     
35 <variablelist>
36   <varlistentry>
37     <term>object_type</term>
38     <listitem>
39       <simpara>Nom du type d'&LSobject; en référence.</simpara>
40     </listitem>
41   </varlistentry>
42
43   <varlistentry>
44     <term>display_name_format</term>
45     <listitem>
46       <simpara>&LSformat; du nom d'affichage des objets lors de leur sélection.</simpara>
47     </listitem>
48   </varlistentry>
49
50   <varlistentry>
51     <term>value_attribute</term>
52     <listitem>
53       <simpara>Nom de l'attribut des &LSobjects; en référence servant de valeur
54       clé et permettant de les identifier (Exemple : <emphasis>dn</emphasis> ou
55       <emphasis>uid</emphasis>).</simpara>
56     </listitem>
57   </varlistentry>
58
59   <varlistentry>
60     <term>filter</term>
61     <listitem>
62       <simpara>Filtre de recherche (facultatif) qui sera ajouter au filtre par défaut
63       lors de la sélection des objets.</simpara>
64     </listitem>
65   </varlistentry>
66
67   <varlistentry>
68     <term>onlyAccessible</term>
69     <listitem>
70       <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>
71     </listitem>
72   </varlistentry>
73 </variablelist>
74
75   </listitem>
76 </varlistentry>
77
78 <varlistentry>
79   <term>ordered</term>
80   <listitem>
81     <simpara>Booléen définissant si la liste des objets choisis doit être
82     ordonnable ou non (Faux par défaut). Cela aura pour effet d'activer une
83     fonctionnalité dynamique de l'interface permettant de remonter ou descendre
84     dans la liste les objets choisis.</simpara>
85     <note><simpara>Cette fonctionnalité désactive automatiquement le trie des
86     objets à l'affichage.</simpara></note>
87   </listitem>
88 </varlistentry>
89
90 <varlistentry>
91   <term>sort</term>
92   <listitem>
93     <simpara>Booléen définissant si la liste des objets choisis doit être
94     triée ou non (Vrai par défaut). Le trie est effectué sur les libellés
95     des objets choisis.</simpara>
96   </listitem>
97 </varlistentry>
98
99 <varlistentry>
100   <term>sortDirection</term>
101   <listitem>
102     <simpara>Mot clé déterminant le sens du trie des objets choisis.</simpara>
103     <simpara>Valeurs possibles : <literal>ASC</literal> ou <literal>DESC</literal> (<literal>ASC</literal> par défaut).</simpara>
104   </listitem>
105 </varlistentry>
106
107 </variablelist>
108   
109   
110 </sect4>