V. Développer avec PHPBoost

Utiliser les alertes administrateurs

PHPBoost est doté d'un système permettant d'envoyer des alertes aux administrateurs. Ce système est notamment utilisé quand un utilisateur souhaite s'inscrire et qu'il faut l'approbation d'un administrateur ou bien encore pour alerter d'une mise à jour d'un module ou de PHPBoost.

Pour ajouter une alerte, rien de plus simple, il vous faudra instancier la classe
AdministratorAlert
et définir un certain nombre d'informations aux variables de cette classe.

Pour cela :

Code PHP :
$alert = new AdministratorAlert();
$alert->set_entitled('valeur'); // Titre que vous souhaitez afficher
$alert->set_fixing_url('valeur'); // Url où rediriger l'administrateur
$alert->set_priority('valeur');  // Niveau de priorité
/* Valeurs : 
AdministratorAlert::ADMIN_ALERT_VERY_LOW_PRIORITY, 
AdministratorAlert::ADMIN_ALERT_LOW_PRIORITY, 
AdministratorAlert::ADMIN_ALERT_MEDIUM_PRIORITY, 
AdministratorAlert::ADMIN_ALERT_HIGH_PRIORITY, 
AdministratorAlert::ADMIN_ALERT_VERY_HIGH_PRIORITY
*/
$alert->set_status('valeur'); // Status : AdministratorAlert::ADMIN_ALERT_STATUS_UNREAD, AdministratorAlert::ADMIN_ALERT_STATUS_PROCESSED
$alert->set_id_in_module('valeur'); // Identifiant de l'élément dans le module
$alert->set_type('member_account_to_approbate'); // Définit le type de l?évènement. Pour récupérer votre cas, vous pourriez avoir besoin d'avoir un type d?évènement, par exemple si votre module possède différents types d?évènements. Avec ce champ, vous pouvez le spécifier.


Pour enregistrer ou modifier l'alerte :

Code PHP :
AdministratorAlertService::save_alert($alert);


Pour la supprimer utilisez :

Code PHP :
AdministratorAlertService::delete_alert($alert);
Cette page a été vue 1563 fois