Messenger.php

<?php
namespace UnicaenApp\View\Helper;

use Exception;
use UnicaenApp\View\Helper\Messenger;
use Zend\View\Helper\AbstractHelper;

/**
 * Aide de vue permettant de stocker une liste de messages d'information de différentes sévérités 
 * et de générer le code HTML pour les afficher (affublés d'un icône correspondant à leur sévérité). 
 * 
 * Possibilité d'importer les messages du FlashMessenger pour les mettre en forme de la même manière.
 *
 * @author Bertrand GAUTHIER <bertrand.gauthier@unicaen.fr>
 */
class Messenger extends AbstractHelper
{
    const INFO    = 'info';
    const SUCCESS = 'success';
    const WARNING = 'warning';
    const ERROR   = 'error';
    
    protected $uiClasses = array( // CSS class, icon name
        self::INFO    => array('info',    'info-sign'),
        self::SUCCESS => array('success', 'ok-sign'),
        self::WARNING => array('warning', 'warning-sign'),
        self::ERROR   => array('error',   'exclamation-sign'),
    );
        
    /**
     * Messages courants
     * @var array
     */
    protected $messages = array();
    
    /**
     * Seule sévérité éventuelle à prendre en compte
     * @var string
     */
    protected $severity = null;


    /**
     * Helper entry point.
     *
     * @param bool $importFlashMessages 
     * @return self
     */
    public function __invoke($importFlashMessages = false)
    {
        if ($importFlashMessages) {
            $this->importFlashMessages();
        }
        
        return $this;
    }

    /**
     * Importe les messages du FlashMessenger.
     * 
     * @return self
     */
    protected function importFlashMessages()
    {
        /* @var $fm \Zend\View\Helper\FlashMessenger */
        $fm = $this->getView()->flashMessenger();
        
        foreach ($fm->getInfoMessages() as $message) {
            $this->addMessage($message, self::INFO);
        }