getMessages

Déclaration

Des messages peuvent être fournis par la méthode IRenderConfig::getMessages(). Ces messages sont affichés dans le notifier de l'interface du Smart Element.

Ces messages sont aussi affichés après le retour de la sauvegarde depuis le formulaire pour les configurations en mode "edition".

use Anakeen\Routes\Core\Lib\ApiMessage;
use Anakeen\Core\Internal\SmartElement;
/**
 * @return ApiMessage[] Menu configuration
 */
public function getMessages(SmartElement $smartElement) : ApiMessage[];

Cette méthode retourne un tableau Anakeen\Routes\Core\Lib\ApiMessage qui contient la définition de chacun des messages à afficher.

Arguments

$smartElement (SmartElement)

Le smart Element à afficher.

Les messages sont typés, la valeur des types sont :

• ApiMessage::SUCCESS : Message de réussite (couleur d'affichage: vert)
• ApiMessage::ERROR : Message d'erreur (couleur d'affichage: rouge)
• ApiMessage::WARNING: Message d'avertissement (couleur d'affichage: orange)
• ApiMessage::MESSAGE: Message d'information (couleur d'affichage: bleu)
• ApiMessage::NOTICE: Message de notification (couleur d'affichage: gris)
• ApiMessage::DEBUG : Message de debug

Un objet ApiMessage prend 2 arguments :

• $message : le texte à afficher
• $type : le type de message

<?php
use Anakeen\Routes\Core\Lib\ApiMessage;
$msg = new ApiMessage("Hello", ApiMessage::MESSAGE);

Exemple

<?php
use Anakeen\Routes\Core\Lib\ApiMessage;

class MyRender extends \Anakeen\Ui\DefaultView
{
  public function getMessages(\Anakeen\Core\Internal\SmartElement $smartElement)
  {
    $messages = parent::getMessages($smartElement);
    $messages[] = new ApiMessage(
      sprintf(___("My internal id is %d", "my"), $smartElement->initid),
      ApiMessage::WARNING
    );

    return $messages;
  }
}