Doc/LSobject/customActions : Added infos about disableOnSuccessMsg parameter
[ldapsaisie.git] / doc / conf / LSobject / customActions.docbook
1 <sect2 id="config-LSobject-customActions">
2   <title>customActions</title>
3   <para>Cette section décrit la manière de configurer les actions personnalisées exécutables
4   sur les &LSobjects; appelées &customActions;.</para>
5   
6 <programlisting>
7 <citetitle>Structure</citetitle>
8 <![CDATA[$GLOBALS['LSobjects']['[nom du type d'LSobject]']['customActions'] = array (
9   'action1' => array(
10     'label' => '[label l'action]',
11     'icon' => '[nom de l'icône de l'action]',
12     'function' => '[fonction à exécuter]',
13     'question_format' => '[LSformat de la question de confirmation]',
14     'onSuccessMsgFormat' => '[LSformat du message à afficher en cas de succès de l'action]',
15     'disableOnSuccessMsg' => '[booléen]',
16     'rights' => array(
17       'LSprofile1',
18       'LSprofile2',
19       ...
20     )
21   )
22 );]]>
23 </programlisting>
24
25 <variablelist>
26 <title>Paramètres de configuration</title>
27
28 <varlistentry>
29   <term>label</term>
30   <listitem>
31     <simpara>Le label de la relation.</simpara>
32   </listitem>
33 </varlistentry>
34
35 <varlistentry>
36   <term>icon</term>
37   <listitem>
38     <simpara>Nom de l'îcone à afficher dans le bouton de l'action. Ce nom correspond
39     au nom du fichier de l'image (sans l'extention) qui devra se trouver dans le 
40     dossier <emphasis>/public_html/images/[nom du theme d'images]/</emphasis>.</simpara>
41   </listitem>
42 </varlistentry>
43
44 <varlistentry>
45   <term>function</term>
46   <listitem>
47     <simpara>Le nom de la fonction à exécuter qui implémente l'action personnalisée
48     Cette fonction prendra en seule paramètre le &LSobject; sur lequel l'action devra
49     être exécutée et retournera <emphasis>True</emphasis> en cas de succès ou 
50     <emphasis>False</emphasis> en cas d'échec d'exécution de la fonction.</simpara>
51   </listitem>
52 </varlistentry>
53
54 <varlistentry>
55   <term>question_format</term>
56   <listitem>
57     <simpara>Le &LSformat; de la question de confirmation d'exécution de l'action.
58     Ce &LSformat; sera composé à l'aide du nom de l'objet.</simpara>
59   </listitem>
60 </varlistentry>
61
62 <varlistentry>
63   <term>onSuccessMsgFormat</term>
64   <listitem>
65     <simpara>Le &LSformat; du message à afficher en cas de succès d'exécution de
66     l'action. Ce &LSformat; sera composé à l'aide du nom de l'objet.</simpara>
67   </listitem>
68 </varlistentry>
69
70 <varlistentry>
71   <term>disableOnSuccessMsg</term>
72   <listitem>
73     <simpara>Booléen permetant de désactiver le message afficher en cas de succès
74     d'exécution de l'action.</simpara>
75   </listitem>
76 </varlistentry>
77
78 <varlistentry>
79   <term>rights</term>
80   <listitem>
81     <simpara>Tableau contenant la liste des noms des &LSprofiles; ayant le droit
82     d'exécuter cette action.</simpara>
83   </listitem>
84 </varlistentry>
85
86 </variablelist>
87
88 <sect3>
89     <title>Ecriture d'une fonction implémentant une customAction</title>
90     <para>Une fonction implémentant une <emphasis>customAction</emphasis> se déclare de
91     la manière suivante :
92     <programlisting linenumbering="unnumbered"><![CDATA[
93 /*
94  * Ma fonction implémentant ma customAction
95  *
96  * Paramètre :
97  *     - $object : Le LSobject sur lequel mon action doit être exécutée
98  *
99  * Valeurs retournées :
100  *     - True : Tout s'est bien passé
101  *     - False : Une erreur est survenue
102  */
103 function maFonction ($object) {
104
105   // Actions
106
107 }
108     ]]></programlisting>
109 Cette fonction doit prendre pour seul paramètre, le &LSobject; sur lequel l'action
110 personnalisée doit être exécutée et doit retourner soit <literal>True</literal> si 
111 tout s'est bien passé, soit <literal>False</literal> en cas de problème.</para>
112
113 <note><simpara>Ces fonctions sont le plus couramment définies au sein d'&LSaddon;.</simpara></note>
114
115 </sect3>
116
117
118 </sect2>