User/MessagesInterface.php at master · CommonApi/User · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
<?php
/**
 * Messages Interface
 *
 * @package    User
 * @copyright  2014-2015 Amy Stephen. All rights reserved.
 * @license    http://www.opensource.org/licenses/mit-license.html MIT License
 */
namespace CommonApi\User;

/**
 * Messages Interface
 *
 * @package    User
 * @license    http://www.opensource.org/licenses/mit-license.html MIT License
 * @copyright  2014-2015 Amy Stephen. All rights reserved.
 * @since      1.0
 */
interface MessagesInterface
{
    /**
     * Set Message
     *
     * @param   int    $message_id
     * @param   string $message
     *
     * @since   1.0.0
     * @return  $this
     */
    public function setMessage($message_id, $message);

    /**
     * Store Flash (User) Messages in Flashmessage for presentation after redirect
     *
     * @param   int    $message_id
     * @param   array  $values
     * @param   string $type (Success, Notice, Warning, Error)
     *
     * @return  $this
     * @since   1.0.0
     */
    public function setFlashmessage($message_id, array $values = array(), $type = 'Error');

    /**
     * Get Message
     *
     * @param   int   $message_id
     * @param   array $values
     *
     * @since   1.0.0
     * @return  string
     */
    public function getMessage($message_id = 0, array $values = array());
}