doc/conf/LSattribute.docbook

   1 <sect2 id="config-LSattribute">
   2   <title>Configuration des attributs</title>
   3   <para>Cette section décrit les options de configuration des attributs des
   4   &LSobjects;. Les attributs sont définis dans le tableau associatif
   5   <varname>attrs</varname> de la configuration des &LSobjects;. Dans ce tableau,
   6   les clé les noms des attributs et les valeurs liés sont la configuration des
   7   attributs.</para>
   8
   9   <warning><simpara>Contrairement à ce qui existe dans le standard LDAP, les
  10   noms des attributs sont sensibles à la casse. Il faut que le nom des attributs
  11   dans &LdapSaisie; soient scrupuleusement les mêmes que ceux retourné par
  12   &netldap;</simpara></warning>
  13
  14 <programlisting linenumbering="unnumbered">
  15 <citetitle>Structure</citetitle>...
  16 <![CDATA['attrs' => array (
  17   /* ----------- start -----------*/
  18   'attr1' => array (
  19     'label' => '[label de l'attr1',
  20     'help_info' => '[Message d'aide sur l'attribut attr1',
  21     'ldap_type' => 'ldaptype1',
  22     'ldap_options' => array(
  23       // Options LDAP liées au type LDAP de l'attribut
  24     ),
  25     'html_type' => 'htmltype1',
  26     'html_options' => array(
  27       // Options HTML liées au type HTML de l'attribut
  28     ),
  29     'multiple' => 0,
  30     'required' => 1,
  31     'generate_function' => 'fonction1',
  32     'generate_value_format' => '[LSformat]',
  33     'default_value' => 'valeur1',
  34     'check_data' => array (
  35       // Régle de vérification syntaxique des données saisies
  36     ),
  37     'validation' => array (
  38       // Règle de vérification d'intégrité des données saisies
  39     ),
  40     'rights' => array(
  41       'LSprofile1' => 'droit1',
  42       'LSprofile2' => 'droit2',
  43       ...
  44     ),
  45     'view' => 1,
  46     'form' => array (
  47       'create' => 1,
  48       'modify' => 0,
  49       ...
  50     ),
  51     'dependAttrs' => array(
  52       // Attributs en dépendance
  53     ),
  54     'onDisplay' => 'fonction2'
  55
  56     'before_modify' => 'function1',
  57     'after_modify' => 'function2'
  58   ),
  59   /* ----------- end -----------*/
  60   ...
  61 );]]>
  62 ...
  63 </programlisting>
  64
  65 <!-- Début Paramètres Configuration -->
  66 <variablelist>
  67 <title>Paramètres de configuration</title>
  68
  69 <varlistentry>
  70   <term>label</term>
  71   <listitem>
  72     <simpara>Le label de l'attribut.</simpara>
  73   </listitem>
  74 </varlistentry>
  75
  76
  77 <varlistentry>
  78   <term>help_info</term>
  79   <listitem>
  80     <simpara>Message d'aide qui sera affiché dans une bulle d'aide à côté du
  81     nom de l'attribut dans les formulaires.</simpara>
  82   </listitem>
  83 </varlistentry>
  84
  85 <varlistentry>
  86   <term>ldap_type</term>
  87   <listitem>
  88     <simpara>Le type LDAP de l'attribut.
  89     <link linkend='config-LSattr_ldap'>Voir la section concernée.</link></simpara>
  90   </listitem>
  91 </varlistentry>
  92
  93 <varlistentry>
  94   <term>ldap_options</term>
  95   <listitem>
  96     <simpara>Tableau associatif contenant les paramètres de configuration du
  97     type LDAP de l'attribut.
  98     <link linkend='config-LSattr_ldap'>Voir la section concernée.</link></simpara>
  99   </listitem>
 100 </varlistentry>
 101
 102 <varlistentry>
 103   <term>html_type</term>
 104   <listitem>
 105     <simpara>Le type HTML de l'attribut.
 106     <link linkend='config-LSattr_html'>Voir la section concernée.</link></simpara>
 107   </listitem>
 108 </varlistentry>
 109
 110 <varlistentry>
 111   <term>html_options</term>
 112   <listitem>
 113     <simpara>Tableau associatif contenant les paramètres de configuration du
 114     type HTML de l'attribut.
 115     <link linkend='config-LSattr_html'>Voir la section concernée.</link></simpara>
 116   </listitem>
 117 </varlistentry>
 118
 119 <varlistentry>
 120   <term>multiple</term>
 121   <listitem>
 122     <simpara>Booléen définissant si cet attribut peut stocker plusieurs valeurs.</simpara>
 123     <simpara>Valeurs possibles : <emphasis>0</emphasis> ou <emphasis>1</emphasis></simpara>
 124     <simpara>Valeur par défaut : <emphasis>0</emphasis></simpara>
 125   </listitem>
 126 </varlistentry>
 127
 128 <varlistentry>
 129   <term>required</term>
 130   <listitem>
 131     <simpara>Booléen définissant si cet attribut doit obligatoirement être
 132     défini.</simpara>
 133     <simpara>Valeurs possibles : <emphasis>0</emphasis> ou <emphasis>1</emphasis></simpara>
 134     <simpara>Valeur par défaut : <emphasis>0</emphasis></simpara>
 135   </listitem>
 136 </varlistentry>
 137
 138 <varlistentry>
 139   <term>generate_function</term>
 140   <listitem>
 141     <simpara>Nom de la fonction permettant de générer la valeur de l'attribut.
 142     Cette fonction sera éxecutée, en passant en premier paramètre, l'objet
 143     &LSobject; courant.</simpara>
 144   </listitem>
 145 </varlistentry>
 146
 147 <varlistentry>
 148   <term>generate_value_format</term>
 149   <listitem>
 150     <simpara>&LSformat; permettant la génération de l'attribut.</simpara>
 151     <note><simpara>Cette méthode de génération est utilisée uniquement si aucune fonction de génération
 152     de la valeur n'est définie (paramètre <parameter>generate_function</parameter>).</simpara></note>
 153   </listitem>
 154 </varlistentry>
 155
 156 <varlistentry>
 157   <term>default_value</term>
 158   <listitem>
 159     <simpara>Valeur par défaut de l'attribut.</simpara>
 160     <simpara>Valeurs possibles : <emphasis>0</emphasis> ou <emphasis>1</emphasis></simpara>
 161     <note><simpara>Cette valeur est également utilisée dans le cadre de la génération automatique
 162     de la valeur de l'attribut si aucune autre méthode n'est disponible (via une fonction ou un &LSformat;).</simpara></note>
 163   </listitem>
 164 </varlistentry>
 165
 166 <varlistentry>
 167   <term>check_data</term>
 168   <listitem>
 169     <simpara>Tableau associatif contenant les règles de vérification syntaxique
 170     des données de l'attribut.<link linkend='config-LSattribute-check-data'>Voir
 171     la section concernée.</link></simpara>
 172   </listitem>
 173 </varlistentry>
 174
 175 <varlistentry>
 176   <term>validation</term>
 177   <listitem>
 178     <simpara>Tableau associatif contenant les règles de vérification d'intégrité
 179     des données de l'attribut.<link linkend='config-LSattribute-validation'>Voir
 180     la section concernée.</link></simpara>
 181   </listitem>
 182 </varlistentry>
 183
 184 <varlistentry>
 185   <term>rights</term>
 186   <listitem>
 187     <simpara>Tableau associatif dont les clés sont les noms des &LSprofiles; ayant
 188     des droits sur cet attribut et les valeurs associées sont les droits
 189     correspondants. La valeur des droits d'un &LSprofile; peut être
 190     <literal>r</literal> pour le droit de lecture ou <literal>w</literal> pour
 191     le droit de lecture-écriture. Par défaut, un &LSprofile; n'a aucun droit.</simpara>
 192   </listitem>
 193 </varlistentry>
 194
 195 <varlistentry>
 196   <term>view</term>
 197   <listitem>
 198     <simpara>Booléen définissant si l'attribut est, ou non, affiché lors de la
 199     visualisation des objets du type courant.</simpara>
 200     <simpara>Valeurs possibles : <emphasis>0</emphasis> ou <emphasis>1</emphasis></simpara>
 201     <simpara>Valeur par défaut : <emphasis>0</emphasis></simpara>
 202   </listitem>
 203 </varlistentry>
 204
 205 <varlistentry>
 206   <term>form</term>
 207   <listitem>
 208     <simpara>Tableau associatif dont les clés sont les noms des &LSforms; et les
 209     valeurs associées la définition de l'affichage dans ce &LSform;. Si cette
 210     valeur vaut <emphasis>0</emphasis>, alors l'attribut sera lecture-seule et si
 211     cette valeur vaut <emphasis>1</emphasis>, cet attribut sera affiché en
 212     lecture-écriture.</simpara>
 213   </listitem>
 214 </varlistentry>
 215
 216 <varlistentry>
 217   <term>dependAttrs</term>
 218   <listitem>
 219     <simpara>Tableau associatif listant les attributs dépendants de celui-ci.
 220     Les attributs listés ici seront regénérés lors de chaque modification
 221     de l'attribut courant. Cette génération sera effectué avec la fonction
 222     définie dans le paramètre <varname>generate_function</varname> de
 223     l'attribut.</simpara>
 224   </listitem>
 225 </varlistentry>
 226
 227 <varlistentry>
 228   <term>onDisplay</term>
 229   <listitem>
 230     <simpara>Nom ou liste de nom des fonctions retournant les valeurs d'affichages
 231     de l'attribut. Si c'est une liste, chacune des fonctions seront executée les
 232     unes après les autres. Ces fonctions seront éxecutées, en passant en premier
 233     paramètre, le tableau des valeurs de l'objet.</simpara>
 234   </listitem>
 235 </varlistentry>
 236
 237 <varlistentry>
 238   <term>before_modify</term>
 239   <listitem>
 240     <simpara>Nom de la fonction qui sera exécutée avant toutes modifications de
 241     la valeur de l'attribut.<link linkend="config-LSattribute-triggers">Voir la
 242     section concernée</link></simpara>
 243   </listitem>
 244 </varlistentry>
 245
 246 <varlistentry>
 247   <term>after_modify</term>
 248   <listitem>
 249     <simpara>Nom de la fonction qui sera exécutée après toutes modifications de
 250     la valeur de l'attribut.<link linkend="config-LSattribute-triggers">Voir la
 251     section concernée</link></simpara>
 252   </listitem>
 253 </varlistentry>
 254
 255 </variablelist>
 256   &conf-LSattribute-LSattr_ldap;
 257   &conf-LSattribute-LSattr_html;
 258
 259   &conf-LSattribute-check-data;
 260   &conf-LSattribute-validation;
 261   &conf-LSattribute-triggers;
 262
 263 </sect2>