Session/src/ArrayManager.php at 687edd8028ce96ce4d76934029067161af65ebf4 · rancoud/Session · 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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
<?php

declare(strict_types=1);

namespace Rancoud\Session;

/**
 * Trait ArrayManager.
 */
trait ArrayManager
{
    protected static array $flashData = [];

    /** @throws SessionException */
    abstract protected static function startSessionIfNotHasStarted();

    /** @throws SessionException */
    abstract protected static function startSessionIfNotHasStartedForceWrite();

    /**
     * @param string $key
     * @param mixed  $value
     *
     * @throws SessionException
     */
    public static function set(string $key, $value): void
    {
        static::startSessionIfNotHasStartedForceWrite();

        $_SESSION[$key] = $value;
    }

    /**
     * @param string $key
     *
     * @throws SessionException
     *
     * @return bool
     */
    public static function has(string $key): bool
    {
        static::startSessionIfNotHasStarted();

        return \array_key_exists($key, $_SESSION);
    }

    /**
     * @param string $key
     * @param mixed  $value
     *
     * @throws SessionException
     *
     * @return bool
     */
    public static function hasKeyAndValue(string $key, $value): bool
    {
        static::startSessionIfNotHasStarted();

        return \array_key_exists($key, $_SESSION) && $_SESSION[$key] === $value;
    }

    /**
     * @param string $key
     *
     * @throws SessionException
     *
     * @return mixed
     */
    public static function get(string $key)
    {
        static::startSessionIfNotHasStarted();

        return (static::has($key)) ? $_SESSION[$key] : null;
    }

    /**
     * @param string $key
     *
     * @throws SessionException
     */
    public static function remove(string $key): void
    {
        static::startSessionIfNotHasStartedForceWrite();

        if (static::has($key)) {
            unset($_SESSION[$key]);
        }
    }

    /**
     * @throws SessionException
     *
     * @return array
     */
    public static function getAll(): array
    {
        static::startSessionIfNotHasStarted();

        return $_SESSION;
    }

    /**
     * @param string $key
     *
     * @throws SessionException
     *
     * @return mixed
     */
    public static function getAndRemove(string $key)
    {
        static::startSessionIfNotHasStartedForceWrite();

        $value = static::get($key);
        static::remove($key);

        return $value;
    }

    /**
     * @param string $key
     * @param mixed  $value
     */
    public static function setFlash(string $key, $value): void
    {
        static::$flashData[$key] = $value;
    }

    /**
     * @param string $key
     *
     * @return bool
     */
    public static function hasFlash(string $key): bool
    {
        return \array_key_exists($key, static::$flashData);
    }

    /**
     * @param string $key
     * @param mixed  $value
     *
     * @return bool
     */
    public static function hasFlashKeyAndValue(string $key, $value): bool
    {
        return \array_key_exists($key, static::$flashData) && static::$flashData[$key] === $value;
    }

    /**
     * @param string $key
     *
     * @return mixed
     */
    public static function getFlash(string $key)
    {
        return (static::hasFlash($key)) ? static::$flashData[$key] : null;
    }

    /**
     * @param string $key
     */
    public static function removeFlash(string $key): void
    {
        if (static::hasFlash($key)) {
            unset(static::$flashData[$key]);
        }
    }

    /**
     * @param array $keys
     *
     * @throws SessionException
     */
    public static function keepFlash(array $keys = []): void
    {
        static::startSessionIfNotHasStartedForceWrite();

        if (empty($keys)) {
            $_SESSION['flash_data'] = static::$flashData;
        } else {
            $_SESSION['flash_data'] = [];

            foreach ($keys as $key) {
                if (static::hasFlash($key)) {
                    $_SESSION['flash_data'][$key] = static::$flashData[$key];
                }
            }
        }
    }

    /**
     * @return array
     */
    public static function getAllFlash(): array
    {
        return static::$flashData;
    }
}