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