Borobudur\Http\Session\Attribute\AttributeBag

Complexity

Total Complexity

19

Size/Duplication

Total Lines	203
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	2
A	replace()	0	6	1
A	add()	0	8	2
A	set()	0	6	1
A	get()	0	8	2
A	has()	0	4	1
A	all()	0	4	1
A	remove()	0	8	2
A	getIterator()	0	4	1
A	count()	0	4	1
A	setName()	0	6	1
A	getName()	0	4	1
A	getStorageKey()	0	4	1
A	initialize()	0	4	1
A	clear()	0	7	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\Attribute;

use ArrayIterator;

/**
 * @author      Iqbal Maulana <iq.bluejack@gmail.com>
 * @created     8/3/15
 */
class AttributeBag implements AttributeBagInterface
{
    /**
     * @var string
     */
    private $name = 'attributes';

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

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

    /**
     * Constructor.
     *
     * @param string $storageKey
     */
    public function __construct($storageKey = '__BOROBUDUR_ATTRIBUTES', $name = null)
    {
        $this->storageKey = $storageKey;
        if (null !== $name) {
            $this->name = $name;
        }
    }

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

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

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

        return $this;
    }

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

        return $this;
    }

    /**
     * Get attribute value by key or return default value if not exist.
     *
     * @param string     $key
     * @param mixed|null $default
     *
     * @return mixed
     */
    public function get($key, $default = null)
    {
        if ($this->has($key)) {
            return $this->attributes[$key];
        }

        return $default;
    }

    /**
     * Check if attribute exist by key.
     *
     * @param string $key
     *
     * @return bool
     */
    public function has($key)
    {
        return array_key_exists($key, $this->attributes);
    }

    /**
     * Get all attributes.
     *
     * @return array
     */
    public function all()
    {
        return $this->attributes;
    }

    /**
     * Remove attribute by key.
     *
     * @param string $key
     *
     * @return $this
     */
    public function remove($key)
    {
        if ($this->has($key)) {
            unset($this->attributes[$key]);
        }

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getIterator()
    {
        return new ArrayIterator($this->attributes);
    }

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

    /**
     * Set attribute name.
     *
     * @param string $name
     *
     * @return $this
     */
    public function setName($name)
    {
        $this->name = $name;

        return $this;
    }

    /**
     * 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->attributes = &$sessions;
    }

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

        return $attributes;
    }
}