customActions
Cette section décrit la manière de configurer les actions personnalisées exécutables
sur les &LSobjects; appelées &customActions;.
Structure
array(
'label' => '[label l'action]',
'icon' => '[nom de l'icône de l'action]',
'function' => '[fonction à exécuter]',
'question_format' => '[LSformat de la question de confirmation]',
'onSuccessMsgFormat' => '[LSformat du message à afficher en cas de succès de l'action]',
'disableOnSuccessMsg' => '[booléen]',
'noConfirmation' => '[booléen]',
'redirectToObjectList' => '[booléen]',
'rights' => array(
'LSprofile1',
'LSprofile2',
...
)
)
);]]>
Paramètres de configuration
label
Le label de la relation.
icon
Nom de l'îcone à afficher dans le bouton de l'action. Ce nom correspond
au nom du fichier de l'image (sans l'extention) qui devra se trouver dans le
dossier /public_html/images/[nom du theme d'images]/.
function
Le nom de la fonction à exécuter qui implémente l'action personnalisée
Cette fonction prendra en seule paramètre le &LSobject; sur lequel l'action devra
être exécutée et retournera True en cas de succès ou
False en cas d'échec d'exécution de la fonction.
question_format
Le &LSformat; de la question de confirmation d'exécution de l'action.
Ce &LSformat; sera composé à l'aide du nom de l'objet.
onSuccessMsgFormat
Le &LSformat; du message à afficher en cas de succès d'exécution de
l'action. Ce &LSformat; sera composé à l'aide du nom de l'objet.
disableOnSuccessMsg
Booléen permetant de désactiver le message afficher en cas de succès
d'exécution de l'action.
noConfirmation
Booléen permetant de désactiver la confirmation de l'exécution de
l'action.
redirectToObjectList
Booléen permetant de rediriger l'utilisateur vers la liste des objets
plutôt que sur la fiche de l'objet après l'execution de l'action.
rights
Tableau contenant la liste des noms des &LSprofiles; ayant le droit
d'exécuter cette action.
Ecriture d'une fonction implémentant une customAction
Une fonction implémentant une customAction se déclare de
la manière suivante :
Cette fonction doit prendre pour seul paramètre, le &LSobject; sur lequel l'action
personnalisée doit être exécutée et doit retourner soit True si
tout s'est bien passé, soit False en cas de problème.
Ces fonctions sont le plus couramment définies au sein d'&LSaddon;.