View source for Création de boutons

Pour chaque enregistrement, il est possible de créer des boutons et d'y associer des actions. On retrouvera par exemple des actions comme valider, désactiver, mettre en brouillon, etc.

Nous utiliserons, dans nos exemples, la possibilité d'activer ou désactiver un enregistrement.

== Fichier class.php ==

=== Constantes ===
Au début du fichier, nous allons vérifier les différentes constantes et les valeurs attribuées.<syntaxhighlight lang="php" line="1">
	const STATUS_DRAFT = -1;
	const STATUS_DISABLED = 0;
	const STATUS_VALIDATED = 1;
	const STATUS_CANCELED = 9;
</syntaxhighlight><br />

=== Création fonctions ===
On vient ensuite ajouter les fonctions<syntaxhighlight lang="php" line="1">
public function enable($user, $notrigger = 0)
	{
	    // Protection pour véfifier le statut de départ
		if ($this->status != self::STATUS_DISABLED) {
			return 0;
		}
		return $this->setStatusCommon($user, self::STATUS_VALIDATED, $notrigger, '');
	}
</syntaxhighlight>

=== Choisir le statut ===
La fonction viendra modifier l'apparence des status :<syntaxhighlight lang="php">
public function LibStatut($status, $mode = 0)
</syntaxhighlight>Pour chaque statut, on peut y venir apposer un numéro de statut et donc une mise en forme particulière :<syntaxhighlight lang="php">
if ($status == self::STATUS_DRAFT) {
    $statusType = 'status1';
}
</syntaxhighlight>


Voici une liste des statuts et de leur apparence (peut varier en fonction des thèmes et versions utilisées) :<gallery mode="packed-overlay">
File:Status0.png|Status 0
File:Status1.png|Status 1
File:Status2.png|Status 2
File:Status3.png|Status 3
File:Status4.png|Status 4
File:Status5.png|Status 5
File:Status6.png|Status 6
File:Status7.png|Status 7
File:Status8.png|Status 8
File:Status9.png|Status 9
File:Status10.png|Status 10
File:Status11.png|Status 11
</gallery><br />

== Fichier _card.php ==

=== Création du bouton ===
Avec le module builder, un fichier _card.php est créé où on y retrouvera le commentaire suivant, en dessous duquel on pourra nos créations :

<nowiki><source lang="php">// Buttons for actions</source></nowiki>


Le code pour ajouter un bouton est le suivant :<syntaxhighlight lang="php" line="1">
if ($permissiontoadd) { // Vérification au niveau des permissions
    if ($object->status == $object::STATUS_VALIDATED) { // Si notre statut est déjà validé, on affiche un bouton pour désactiver
        print dolGetButtonAction('',$langs->trans('Disable'), 'default', $_SERVER['PHP_SELF'].'?id='.$object->id.'&action=disable&token='.newToken(), '', $permissiontoadd);
    } else { // Si notre statut est désactivé on afficher un bouton pour le réactiver
        print dolGetButtonAction('',$langs->trans('Enable'), 'default', $_SERVER['PHP_SELF'].'?id='.$object->id.'&action=enable&token='.newToken(), '', $permissiontoadd);
    }
}
</syntaxhighlight>

=== Appel de l'action ===
Dans le haut du fichier _card.php, on retrouvera le commentaire suivant :<syntaxhighlight lang="php">
/*
* Actions
*/
</syntaxhighlight>


C'est à ce niveau que l'on va venir ajouter les appels de fonction, que nous avons mis dans la création de nos bouttons<syntaxhighlight lang="php" line="1">
if ($action == 'enable' && $permissiontoadd) { // Si on choisit l'action enable et que nous en avons la permission
    $object->enable($object->fk_user_modif,0); // Nous appelons la fonction enable, qui se trouve dans notreobjet/class.php
    setEventMessages("", "Bénéficiaire activé", 'mesgs');
}

if ($action == 'disable' && $permissiontoadd) {
    if ($object->action_fin == null) { // On peut ajouter une condition et un message d'erreur pour bloquer la désactivation
    setEventMessages("", "Il faut ajouter une date de fin de l'action pour pouvoir désactiver un bénéficiaire", 'errors');
}
else {
    $object->disable($object->fk_user_modif,0);
    setEventMessages("", "Bénéficiaire désactivé", 'mesgs'); // Ou bien ajouter un message pour indiquer la bonne marche des choses
}
</syntaxhighlight><br />