Borobudur\Http\AbstractParameterBag

Complexity

Total Complexity

16

Size/Duplication

Total Lines	157
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	2
A	replace()	0	6	1
A	add()	0	10	3
A	all()	0	4	1
A	values()	0	4	1
A	keys()	0	4	1
A	get()	0	8	2
A	has()	0	4	1
A	filter()	0	6	1
A	getIterator()	0	4	1
A	count()	0	4	1
A	remove()	0	6	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;

use ArrayIterator;
use Countable;
use IteratorAggregate;

/**
 * @author      Iqbal Maulana <iq.bluejack@gmail.com>
 * @created     8/6/15
 */
abstract class AbstractParameterBag implements IteratorAggregate, Countable
{
    /**
     * @var array
     */
    protected $parameters = array();

    /**
     * Constructor.
     *
     * @param array $parameters
     */
    public function __construct(array $parameters = array())
    {
        if (!empty($parameters)) {
            $this->replace($parameters);
        }
    }

    /**
     * Reset parameters and replace with new one.
     *
     * @param array $parameters
     *
     * @return $this
     */
    public function replace(array $parameters)
    {
        $this->parameters = array();

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

    /**
     * Add parameters.
     *
     * @param array $parameters
     *
     * @return $this
     */
    public function add(array $parameters)
    {
        foreach($parameters as $key => $value) {
            if (method_exists($this, 'set')) {
                $this->{'set'}($key, $value);
            }
        }

        return $this;
    }

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

    /**
     * Get all parameter values.
     *
     * @return array
     */
    public function values()
    {
        return array_values($this->parameters);
    }

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

    /**
     * Get parameter by key and return default value if not exists.
     *
     * @param string     $key
     * @param mixed|null $default
     *
     * @return mixed|null
     */
    public function get($key, $default = null)
    {
        if (isset($this->parameters[$key])) {
            return $this->parameters[$key];
        }

        return $default;
    }

    /**
     * Check if parameter exist by key.
     *
     * @param string $key
     *
     * @return bool Return true if parameter exist, false otherwise
     */
    public function has($key)
    {
        return array_key_exists($key, $this->parameters);
    }

    /**
     * Get parameter with key and filter the value.
     *
     * @param string     $key
     * @param int        $filter
     * @param mixed|null $default
     * @param array|null $options
     *
     * @return mixed
     */
    public function filter($key, $filter = FILTER_DEFAULT, $default = null, array $options = null)
    {
        $variable = $this->get($key, $default);

        return filter_var($variable, $filter, $options);
    }

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

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

    /**
     * Remove parameter by key.
     *
     * @param string $key
     *
     * @return $this
     */
    public function remove($key)
    {
        unset($this->parameters[$key]);

        return $this;
    }
}