Messenger.php 9.06 KB
Newer Older
1
2
3
<?php
namespace UnicaenApp\View\Helper;

4
use UnicaenApp\Exception\LogicException;
5
6
7
8
9
10
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é). 
11
12
 * 
 * Possibilité d'importer les messages du FlashMessenger pour les mettre en forme de la même manière.
13
14
15
16
17
18
 *
 * @author Bertrand GAUTHIER <bertrand.gauthier@unicaen.fr>
 */
class Messenger extends AbstractHelper
{
    const INFO    = 'info';
19
    const SUCCESS = 'success';
20
    const WARNING = 'warning';
21
    const ERROR   = 'danger';
22
23
    
    protected $uiClasses = array( // CSS class, icon name
24
25
26
        self::INFO    => array('info',    'info-sign'),
        self::SUCCESS => array('success', 'ok-sign'),
        self::WARNING => array('warning', 'warning-sign'),
27
        self::ERROR   => array('danger',  'exclamation-sign'),
28
    );
29
    
30
31
32
33
34
35
36
37
38
39
40
    /**
     * Messages courants
     * @var array
     */
    protected $messages = array();
    
    /**
     * Seule sévérité éventuelle à prendre en compte
     * @var string
     */
    protected $severity = null;
41
    
42
43
44
45
46
47
    /**
     * Activation ou non de l'affichage de l'icône
     * @var bool
     */
    protected $withIcon = true;
    
48
49
50
51
    /**
     * @var string
     */
    protected $containerInnerTemplate = '%s';
52
53

    /**
54
     * Helper entry point.
55
     *
56
57
     * @param bool $importFlashMessages 
     * @return self
58
     */
59
    public function __invoke($importFlashMessages = false)
60
    {
61
62
        if ($importFlashMessages) {
            $this->importFlashMessages();
63
        }
64
        
65
66
        return $this;
    }
67
    
68
69
70
71
72
73
74
    /**
     * Retourne le code HTML généré par cette aide de vue.
     * 
     * @return string
     */
    public function __toString()
    {
75
76
77
78
79
80
        try {
            return $this->render();
        }
        catch (\Exception $exc) {
            var_dump($exc->getMessage(), $exc->getTraceAsString());die;
        }
81
    }
82
83

    /**
84
     * Génère le code HTML.
85
86
87
     * 
     * @return string
     */
88
    protected function render()
89
90
91
92
93
94
95
96
    {
        if (!$this->hasMessages()) {
            return '';
        }

        $messages = (array)$this->getMessages();
        $out = '';

97
98
99
100
//        if ($this->severity && isset($messages[$this->severity])) {
//            // on ne conserve que la sévérité éventuellement demandée
//            $messages = array($this->severity => $messages[$this->severity]);
//        }
101
        foreach ($messages as $key => $message) {
102
103
104
105
106
//            if (is_array($message)) {
//                if ($this->severity && isset($message[$this->severity])) {
//                    // on ne conserve que la sévérité éventuellement demandée
//                    $message = array($this->severity => $message[$this->severity]);
//                }
107
108
109
110
111
112
                foreach ($message as $s => $m) {
                    $out .= sprintf(
                            $this->getTemplate(is_string($key) ? $key : (is_string($s) ? $s : 'info')),
                            implode('<br />', (array)$m)
                    );
                }
113
114
115
116
117
118
119
//            }
//            else {
//                $s = is_string($key) ? $key : ($this->severity ? $this->severity : 'info');
////                if ($this->severity && $this->severity == $s) {
////                    $out .= sprintf($this->getTemplate($s), $message) . '<br />';
////                }
//            }
120
121
122
123
124
        }

        return $out;
    }

125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
    /**
     * Importe les messages du FlashMessenger.
     * 
     * @return self
     */
    protected function importFlashMessages()
    {
        /* @var $fm \Zend\View\Helper\FlashMessenger */
        $fm = $this->getView()->getHelperPluginManager()->get('flashMessenger');
        
        foreach ($fm->getErrorMessages() as $message) {
            $this->addMessage($message, self::ERROR);
        }
        foreach ($fm->getSuccessMessages() as $message) {
            $this->addMessage($message, self::SUCCESS);
        }
141
142
143
        foreach ($fm->getInfoMessages() as $message) {
            $this->addMessage($message, self::INFO);
        }
144
145
146
        
        return $this;
    }
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
    
    /**
     * Spécifie l'unique message courant au format Exception.
     * 
     * @param \Exception $exception Exception
     * @param string $severity Ex: Messenger::INFO
     * @return Messenger
     */
    public function setException(\Exception $exception, $severity = self::ERROR)
    {
        $message = sprintf("<p><strong>%s</strong></p>", $exception->getMessage());
        if (($previous = $exception->getPrevious())) {
            $message .= sprintf("<p>Cause :<br />%s</p>", $previous->getMessage());
        }
        return $this->setMessages(array($severity => $message));
    }
163

164
165
166
167
168
169
170
171
172
173
    /**
     * Spécifie les messages courants (remplaçant les messages existants).
     * 
     * @param string|array $messages
     * @return Messenger
     */
    public function setMessages($messages)
    {
        $this->messages = array();
        foreach ((array)$messages as $severity => $message) {
174
            $this->addMessage($message, $severity);
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
        }
        return $this;
    }
    
    /**
     * Spécifie l'unique message courant.
     * 
     * @param string $message Message
     * @param string $severity Ex: Messenger::INFO
     * @return Messenger
     */
    public function setMessage($message, $severity = self::INFO)
    {
        return $this->setMessages(array($severity => $message));
    }
    
    /**
     * Indique si cette aide de vue contient des messages actuellement.
     * 
     * @param string $severity Seule sévérité éventuelle à prendre en compte, ex: Messenger::INFO
     * @return bool
     */
    public function hasMessages($severity = null)
    {
        return (boolean)$this->getMessages($severity);
    }
    
    /**
     * Retourne les messages courants.
     * 
     * @param string $severity Seule sévérité éventuelle à prendre en compte, ex: Messenger::INFO
     * @return array
     */
    public function getMessages($severity = null)
    {
        if ($severity && array_key_exists($severity, $this->messages)) {
            return $this->messages[$severity];
        }
        return $this->messages;
    }
    
    /**
     * Ajoute un message.
     * 
     * @param string $message Message
     * @param string $severity Sévérité, ex: Messenger::INFO
     * @return Messenger
     */
    public function addMessage($message, $severity = self::INFO)
    {
225
226
227
        if (!$severity || !is_string($severity)) {
            $severity = self::INFO;
        }
228
229
230
231
        $this->messages[$severity][] = $message;
        return $this;
    }
    
232
233
234
235
236
237
238
239
240
    /**
     * Ajoute plusieurs messages.
     * 
     * @param array $messages [Sévérité => Message]
     * @return Messenger
     */
    public function addMessages($messages)
    {
        foreach ($messages as $severity => $message) {
241
            $this->addMessage($message, $severity);
242
243
244
245
        }
        return $this;
    }
    
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
    /**
     * Supprime tous les messages courants.
     * 
     * @param string $severity Seule sévérité éventuelle à prendre en compte, ex: Messenger::INFO
     * @return Messenger
     */
    public function clearMessages($severity = null)
    {
        if ($severity && array_key_exists($severity, $this->getMessages())) {
            $this->messages[$severity] = array();
        }
        else {
            $this->messages = array();
        }
        return $this;
    }
262
263
264
265
266
267
268
269
270
271
272
273
    
    /**
     * Active ou non l'affichage de l'icône.
     * 
     * @param bool $withIcon <tt>true</tt> pour activer l'affichage de l'icône.
     * @return Messenger
     */
    public function withIcon($withIcon = true)
    {
        $this->withIcon = (bool) $withIcon;
        return $this;
    }
274
275

    /**
276
     * Retourne le motif utilisé pour générer le conteneur de chaque message à afficher.
277
278
     *
     * @param string $severity Ex: Messenger::INFO
279
     * @param string $containerId Dom id éventuel à utiliser pour la div englobante
280
281
     * @return string 
     */
282
    public function getTemplate($severity, $containerId = null)
283
284
    {
        if (!isset($this->uiClasses[$severity])) {
285
            throw new LogicException("Sévérité inconnue: " . $severity);
286
287
        }
        
288
        $innerTemplate = $this->containerInnerTemplate ?: '%s';
289
290
        $iconMarkup    = $this->withIcon ? "<span class=\"glyphicon glyphicon-{$this->uiClasses[$severity][1]}\"></span> " : null;
        $containerId   = $containerId ? sprintf('id="%s"', $containerId) : '';
291
292

        $template = <<<EOT
293
<div class="messenger alert alert-{$this->uiClasses[$severity][0]}" {$containerId}>
294
295
    <button type="button" class="close" title="Fermer cette alerte" data-dismiss="alert">&times;</button>
    $iconMarkup 
296
    $innerTemplate
297
</div>
298
299
300
EOT;
        return $template . PHP_EOL;
    }
301
302
303
304
305
306
307
308
309
310
311
    
    /**
     * 
     * @param string $containerInnerTemplate 
     * @return self
     */
    public function setContainerInnerTemplate($containerInnerTemplate = '%s')
    {
        $this->containerInnerTemplate = $containerInnerTemplate;
        return $this;
    }
312
}