Particle\Filter\Value\Container

Complexity

Total Complexity

17

Size/Duplication

Total Lines	138
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	10
Bugs	0	Features	5

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	has()	0	4	1
A	get()	0	4	1
A	remove()	0	4	1
A	set()	0	8	2
A	getArrayCopy()	0	4	1
A	traverse()	0	11	4
A	setTraverse()	0	12	2
A	removeRecursive()	0	17	4

<?php
/**
 * Particle.
 *
 * @link      http://github.com/particle-php for the canonical source repository
 * @copyright Copyright (c) 2005-2015 Particle (http://particle-php.com)
 * @license   https://github.com/particle-php/validator/blob/master/LICENSE New BSD License
 */
namespace Particle\Filter\Value;

/**
 * This class is used to wrap both input as output arrays.
 *
 * @package Particle\Validator
 */
class Container
{
    /**
     * Contains the values (either input or output).
     *
     * @var array
     */
    protected $values = [];

    /**
     * Construct the Value\Container.
     *
     * @param array $values
     */
    public function __construct(array $values = [])
    {
        $this->values = $values;
    }

    /**
     * Determines whether or not the container has a value for key $key.
     *
     * @param string $key
     * @return bool
     */
    public function has($key)
    {
        return $this->traverse($key, false);
    }

    /**
     * Returns the value for the key $key, or null if the value doesn't exist.
     *
     * @param string $key
     * @return mixed
     */
    public function get($key)
    {
        return $this->traverse($key, true);
    }

    /**
     * Removes a value from the container
     *
     * @param string $key
     */
    public function remove($key)
    {
        $this->removeRecursive(explode('.', $key), $this->values);
    }

    /**
     * Set the value of $key to $value.
     *
     * @param string $key
     * @param mixed $value
     * @return $this
     */
    public function set($key, $value)
    {
        if (strpos($key, '.') !== false) {
            return $this->setTraverse($key, $value);
        }
        $this->values[$key] = $value;
        return $this;
    }

    /**
     * Returns a plain array representation of the Value\Container object.
     *
     * @return array
     */
    public function getArrayCopy()
    {
        return $this->values;
    }

    /**
     * Traverses the key using dot notation. Based on the second parameter, it will return the value or if it was set.
     *
     * @param string $key
     * @param bool $returnValue
     * @return mixed
     */
    protected function traverse($key, $returnValue = true)
    {
        $value = $this->values;
        foreach (explode('.', $key) as $part) {
            if (!array_key_exists($part, $value)) {
                return false;
            }
            $value = $value[$part];
        }
        return $returnValue ? $value : true;
    }

    /**
     * Uses dot-notation to set a value.
     *
     * @param string $key
     * @param mixed $value
     * @return $this
     */
    protected function setTraverse($key, $value)
    {
        $parts = explode('.', $key);
        $ref = &$this->values;

        foreach ($parts as $i => $part) {
            $ref = &$ref[$part];
        }

        $ref = $value;
        return $this;
    }

    /**
     * @param array $keyParts
     * @param array $values
     */
    private function removeRecursive(array $keyParts, array &$values)
    {
        $key = $keyParts[0];
        if (array_key_exists($key, $values)) {
            if (is_array($values[$key])) {
                $this->removeRecursive(array_splice($keyParts, 1), $values[$key]);

                // unset self if the removed child clears this array
                if (count($values[$key]) === 0) {
                    unset($values[$key]);
                }
                return;
            }
            // Key is value, unset
            unset($values[$key]);
        }
    }
}