Borobudur\Http\Session\Flash\FlashBag

Complexity

Total Complexity

33

Size/Duplication

Total Lines	310
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	replaceKeep()	0	6	1
A	addKeep()	0	8	2
A	setKeep()	0	6	1
A	isKept()	0	4	1
A	removeKeep()	0	8	2
A	replace()	0	6	1
A	add()	0	8	2
A	set()	0	6	1
A	peek()	0	8	2
A	peekAll()	0	4	1
A	get()	0	11	2
A	has()	0	4	1
A	all()	0	11	3
A	keys()	0	4	1
A	count()	0	4	1
A	getName()	0	4	1
A	getStorageKey()	0	4	1
A	initialize()	0	13	3
A	flush()	0	10	4
A	clear()	0	4	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 <iq.bluejack@gmail.com>
 * @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();
    }
}