Test Failed
Push — develop ( aad200...149858 )
by nguereza
03:52 queued 53s
created

Flash::getError()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 1
nc 1
nop 0
dl 0
loc 3
rs 10
c 1
b 0
f 0
1
<?php
2
3
/**
4
 * Platine Framework
5
 *
6
 * Platine Framework is a lightweight, high-performance, simple and elegant
7
 * PHP Web framework
8
 *
9
 * This content is released under the MIT License (MIT)
10
 *
11
 * Copyright (c) 2020 Platine Framework
12
 *
13
 * Permission is hereby granted, free of charge, to any person obtaining a copy
14
 * of this software and associated documentation files (the "Software"), to deal
15
 * in the Software without restriction, including without limitation the rights
16
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17
 * copies of the Software, and to permit persons to whom the Software is
18
 * furnished to do so, subject to the following conditions:
19
 *
20
 * The above copyright notice and this permission notice shall be included in all
21
 * copies or substantial portions of the Software.
22
 *
23
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29
 * SOFTWARE.
30
 */
31
32
/**
33
 *  @file Flash.php
34
 *
35
 *  The Flash message management class
36
 *
37
 *  @package    Platine\Framework\Helper
38
 *  @author Platine Developers team
39
 *  @copyright  Copyright (c) 2020
40
 *  @license    http://opensource.org/licenses/MIT  MIT License
41
 *  @link   http://www.iacademy.cf
42
 *  @version 1.0.0
43
 *  @filesource
44
 */
45
46
declare(strict_types=1);
47
48
namespace Platine\Framework\Helper;
49
50
use Platine\Session\Session;
51
52
/**
53
 * @class Flash
54
 * @package Platine\Framework\Helper
55
 */
56
class Flash
57
{
58
59
    /**
60
     * The session instance
61
     * @var Session
62
     */
63
    protected Session $session;
64
65
    /**
66
     * Create new instance
67
     * @param Session $session
68
     */
69
    public function __construct(Session $session)
70
    {
71
        $this->session = $session;
72
    }
73
74
    /**
75
     * Set flash error
76
     * @param string $message
77
     * @return $this
78
     */
79
    public function setError(string $message): self
80
    {
81
        $this->session->setFlash('error', $message);
82
83
        return $this;
84
    }
85
86
    /**
87
     * Set flash success
88
     * @param string $message
89
     * @return $this
90
     */
91
    public function setSuccess(string $message): self
92
    {
93
        $this->session->setFlash('success', $message);
94
95
        return $this;
96
    }
97
98
    /**
99
     * Set flash information
100
     * @param string $message
101
     * @return $this
102
     */
103
    public function setInfo(string $message): self
104
    {
105
        $this->session->setFlash('info', $message);
106
107
        return $this;
108
    }
109
110
    /**
111
     * Set flash warning
112
     * @param string $message
113
     * @return $this
114
     */
115
    public function setWarning(string $message): self
116
    {
117
        $this->session->setFlash('warning', $message);
118
119
        return $this;
120
    }
121
122
    /**
123
     * Return the success flash
124
     * @return string|null
125
     */
126
    public function getSuccess(): ?string
127
    {
128
        return $this->session->getFlash('success');
129
    }
130
131
    /**
132
     * Return the error flash
133
     * @return string|null
134
     */
135
    public function getError(): ?string
136
    {
137
        return $this->session->getFlash('error');
138
    }
139
140
    /**
141
     * Return the info flash
142
     * @return string|null
143
     */
144
    public function getInfo(): ?string
145
    {
146
        return $this->session->getFlash('info');
147
    }
148
149
    /**
150
     * Return the warning flash
151
     * @return string|null
152
     */
153
    public function getWarning(): ?string
154
    {
155
        return $this->session->getFlash('warning');
156
    }
157
}
158