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