FlashBag::__construct() - Code Metrics - borobudur-php/borobudur-http - Measure and Improve Code Quality continuously with Scrutinizer

FlashBag::__construct() A
last analyzed 2016-10-06 17:05 UTC

↳ Parent: FlashBag

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1

<?php
/*
 * This file is part of the Borobudur-Http package.
 *
 * (c) Hexacodelabs <http://hexacodelabs.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Borobudur\Http\Session\Flash;

/**
 * @author      Iqbal Maulana <[email protected]>
 * @created     8/3/15
 */
class FlashBag implements FlashBagInterface
{
    /**
     * @var string
     */
    private $name = 'flashes';

    /**
     * @var string
     */
    private $storageKey;

    /**
     * @var array
     */
    private $flashes = array();

    /**
     * @var array
     */
    private $keeps = array();

    /**
     * Constructor.
     *
     * @param string $storageKey
     */
    public function __construct($storageKey = '___BOROBUDUR_FLASHES')
    {
        $this->storageKey = $storageKey;
    }

    /**
     * Clear keep keys and replace with sets of it.
     *
     * @param array $keys
     *
     * @return $this
     */
    public function replaceKeep(array $keys)
    {
        $this->keeps = array();

        return $this->add($keys);
    }

    /**
     * Add sets of keep keys.
     *
     * @param array $keys
     *
     * @return $this
     */
    public function addKeep(array $keys)
    {
        foreach ($keys as $key) {
            $this->setKeep($key);
        }

        return $this;
    }

    /**
     * Set keep key.
     *
     * Keep data with specified key.
     *
     * @param string $key
     *
     * @return $this
     */
    public function setKeep($key)
    {
        $this->keeps[] = $key;

        return $this;
    }

    /**
     * Check if specified key is kept.
     *
     * @param string $key
     *
     * @return bool
     */
    public function isKept($key)
    {
        return in_array($key, $this->keeps);
    }

    /**
     * Remove keep key.
     *
     * @param string $key
     *
     * @return $this
     */
    public function removeKeep($key)
    {
        if ($this->isKept($key)) {
            unset($this->keeps[$key]);
        }

        return $this;
    }

    /**
     * Clear all flash data and replace with sets of it.
     *
     * @param array $values
     *
     * @return $this
     */
    public function replace(array $values)
    {
        $this->flashes = array();

        return $this->add($values);
    }

    /**
     * Add sets of flash data.
     *
     * @param array $values
     *
     * @return $this
     */
    public function add(array $values)
    {
        foreach ($values as $key => $value) {
            $this->set($key, $value);
        }

        return $this;
    }

    /**
     * Set flash data.
     *
     * @param string $key
     * @param mixed  $value
     *
     * @return $this
     */
    public function set($key, $value)
    {
        $this->flashes[$key] = $value;

        return $this;
    }

    /**
     * Get flash data by key.
     *
     * @param string     $key
     * @param mixed|null $default
     *
     * @return mixed
     */
    public function peek($key, $default = null)
    {
        if ($this->has($key)) {
            return $this->flashes[$key];
        }

        return $default;
    }

    /**
     * Get all flash data.
     *
     * @return array
     */
    public function peekAll()
    {
        return $this->flashes;
    }

    /**
     * Get flash data by key and clear it.
     *
     * @param string     $key
     * @param mixed|null $default
     *
     * @return mixed
     */
    public function get($key, $default = null)
    {
        if ($this->has($key)) {
            $flash = $this->flashes[$key];
            $this->flush($key);

            return $flash;
        }

        return $default;
    }

    /**
     * Check if flash data exist or not by key.
     *
     * @param string $key
     *
     * @return bool
     */
    public function has($key)
    {
        return array_key_exists($key, $this->flashes);
    }

    /**
     * Get all flash data and clear it.
     *
     * @return array
     */
    public function all()
    {
        $flashes = $this->flashes;
        if (!empty($this->keeps)) {
            foreach ($this->keys() as $key) {
                $this->flush($key);
            }
        }

        return $flashes;
    }

    /**
     * Get all flash data keys.
     *
     * @return array
     */
    public function keys()
    {
        return array_keys($this->flashes);
    }

    /**
     * {@inheritdoc}
     */
    public function count()
    {
        return count($this->flashes);
    }

    /**
     * Get session bag name.
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Identity storage.
     *
     * @return string
     */
    public function getStorageKey()
    {
        return $this->storageKey;
    }

    /**
     * Initialize sessions.
     *
     * @param array $sessions
     */
    public function initialize(array &$sessions)
    {
        $this->flashes = &$sessions['flashes'];
        $this->keeps = &$sessions['keeps'];

        if (null === $this->flashes) {
            $this->flashes = array();
        }

        if (null === $this->keeps) {
            $this->keeps = array();
        }
    }

    /**
     * Flush un-keep flash.
     *
     * @param string $key
     */
    private function flush($key)
    {
        if (!empty($this->keeps)) {
            if (!in_array($key, $this->keeps) && $this->has($key)) {
                unset($this->flashes[$key]);
            }
        } else {
            unset($this->flashes[$key]);
        }
    }

    /**
     * Clear session and return all data.
     *
     * @return array
     */
    public function clear()
    {
        return $this->all();
    }
}


1			<?php
2			/*
3			* This file is part of the Borobudur-Http package.
4			*
5			* (c) Hexacodelabs <http://hexacodelabs.com>
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10
11			namespace Borobudur\Http\Session\Flash;
12
13			/**
14			* @author Iqbal Maulana <[email protected]>
15			* @created 8/3/15
16			*/
17			class FlashBag implements FlashBagInterface
18			{
19			/**
20			* @var string
21			*/
22			private $name = 'flashes';
23
24			/**
25			* @var string
26			*/
27			private $storageKey;
28
29			/**
30			* @var array
31			*/
32			private $flashes = array();
33
34			/**
35			* @var array
36			*/
37			private $keeps = array();
38
39			/**
40			* Constructor.
41			*
42			* @param string $storageKey
43			*/
44			public function __construct($storageKey = '___BOROBUDUR_FLASHES')
45			{
46			$this->storageKey = $storageKey;
47			}
48
49			/**
50			* Clear keep keys and replace with sets of it.
51			*
52			* @param array $keys
53			*
54			* @return $this
55			*/
56			public function replaceKeep(array $keys)
57			{
58			$this->keeps = array();
59
60			return $this->add($keys);
61			}
62
63			/**
64			* Add sets of keep keys.
65			*
66			* @param array $keys
67			*
68			* @return $this
69			*/
70			public function addKeep(array $keys)
71			{
72			foreach ($keys as $key) {
73			$this->setKeep($key);
74			}
75
76			return $this;
77			}
78
79			/**
80			* Set keep key.
81			*
82			* Keep data with specified key.
83			*
84			* @param string $key
85			*
86			* @return $this
87			*/
88			public function setKeep($key)
89			{
90			$this->keeps[] = $key;
91
92			return $this;
93			}
94
95			/**
96			* Check if specified key is kept.
97			*
98			* @param string $key
99			*
100			* @return bool
101			*/
102			public function isKept($key)
103			{
104			return in_array($key, $this->keeps);
105			}
106
107			/**
108			* Remove keep key.
109			*
110			* @param string $key
111			*
112			* @return $this
113			*/
114			public function removeKeep($key)
115			{
116			if ($this->isKept($key)) {
117			unset($this->keeps[$key]);
118			}
119
120			return $this;
121			}
122
123			/**
124			* Clear all flash data and replace with sets of it.
125			*
126			* @param array $values
127			*
128			* @return $this
129			*/
130			public function replace(array $values)
131			{
132			$this->flashes = array();
133
134			return $this->add($values);
135			}
136
137			/**
138			* Add sets of flash data.
139			*
140			* @param array $values
141			*
142			* @return $this
143			*/
144			public function add(array $values)
145			{
146			foreach ($values as $key => $value) {
147			$this->set($key, $value);
148			}
149
150			return $this;
151			}
152
153			/**
154			* Set flash data.
155			*
156			* @param string $key
157			* @param mixed $value
158			*
159			* @return $this
160			*/
161			public function set($key, $value)
162			{
163			$this->flashes[$key] = $value;
164
165			return $this;
166			}
167
168			/**
169			* Get flash data by key.
170			*
171			* @param string $key
172			* @param mixed\|null $default
173			*
174			* @return mixed
175			*/
176			public function peek($key, $default = null)
177			{
178			if ($this->has($key)) {
179			return $this->flashes[$key];
180			}
181
182			return $default;
183			}
184
185			/**
186			* Get all flash data.
187			*
188			* @return array
189			*/
190			public function peekAll()
191			{
192			return $this->flashes;
193			}
194
195			/**
196			* Get flash data by key and clear it.
197			*
198			* @param string $key
199			* @param mixed\|null $default
200			*
201			* @return mixed
202			*/
203			public function get($key, $default = null)
204			{
205			if ($this->has($key)) {
206			$flash = $this->flashes[$key];
207			$this->flush($key);
208
209			return $flash;
210			}
211
212			return $default;
213			}
214
215			/**
216			* Check if flash data exist or not by key.
217			*
218			* @param string $key
219			*
220			* @return bool
221			*/
222			public function has($key)
223			{
224			return array_key_exists($key, $this->flashes);
225			}
226
227			/**
228			* Get all flash data and clear it.
229			*
230			* @return array
231			*/
232			public function all()
233			{
234			$flashes = $this->flashes;
235			if (!empty($this->keeps)) {
236			foreach ($this->keys() as $key) {
237			$this->flush($key);
238			}
239			}
240
241			return $flashes;
242			}
243
244			/**
245			* Get all flash data keys.
246			*
247			* @return array
248			*/
249			public function keys()
250			{
251			return array_keys($this->flashes);
252			}
253
254			/**
255			* {@inheritdoc}
256			*/
257			public function count()
258			{
259			return count($this->flashes);
260			}
261
262			/**
263			* Get session bag name.
264			*
265			* @return string
266			*/
267			public function getName()
268			{
269			return $this->name;
270			}
271
272			/**
273			* Identity storage.
274			*
275			* @return string
276			*/
277			public function getStorageKey()
278			{
279			return $this->storageKey;
280			}
281
282			/**
283			* Initialize sessions.
284			*
285			* @param array $sessions
286			*/
287			public function initialize(array &$sessions)
288			{
289			$this->flashes = &$sessions['flashes'];
290			$this->keeps = &$sessions['keeps'];
291
292			if (null === $this->flashes) {
293			$this->flashes = array();
294			}
295
296			if (null === $this->keeps) {
297			$this->keeps = array();
298			}
299			}
300
301			/**
302			* Flush un-keep flash.
303			*
304			* @param string $key
305			*/
306			private function flush($key)
307			{
308			if (!empty($this->keeps)) {
309			if (!in_array($key, $this->keeps) && $this->has($key)) {
310			unset($this->flashes[$key]);
311			}
312			} else {
313			unset($this->flashes[$key]);
314			}
315			}
316
317			/**
318			* Clear session and return all data.
319			*
320			* @return array
321			*/
322			public function clear()
323			{
324			return $this->all();
325			}
326			}
327

borobudur-php / borobudur-http

FlashBag::__construct() A last analyzed 2016-10-06 17:05 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

FlashBag::__construct() A
last analyzed 2016-10-06 17:05 UTC