Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
0.00% covered (danger)
0.00%
0 / 1
14.29% covered (danger)
14.29%
1 / 7
CRAP
8.11% covered (danger)
8.11%
3 / 37
Context
0.00% covered (danger)
0.00%
0 / 1
14.29% covered (danger)
14.29%
1 / 7
241.25
8.11% covered (danger)
8.11%
3 / 37
 __construct
100.00% covered (success)
100.00%
1 / 1
1
100.00% covered (success)
100.00%
3 / 3
 add
0.00% covered (danger)
0.00%
0 / 1
12
0.00% covered (danger)
0.00%
0 / 6
 contains
0.00% covered (danger)
0.00%
0 / 1
12
0.00% covered (danger)
0.00%
0 / 6
 addArray
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 5
 addObject
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 4
 containsArray
0.00% covered (danger)
0.00%
0 / 1
20
0.00% covered (danger)
0.00%
0 / 10
 containsObject
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 3
<?php
/*
 * This file is part of the Recursion Context package.
 *
 * (c) Sebastian Bergmann <sebastian@phpunit.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace SebastianBergmann\RecursionContext;
/**
 * A context containing previously processed arrays and objects
 * when recursively processing a value.
 *
 * @author     Sebastian Bergmann <sebastian@phpunit.de>
 * @author     Adam Harvey <aharvey@php.net>
 * @copyright  Sebastian Bergmann <sebastian@phpunit.de>
 * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
 * @link       https://github.com/sebastianbergmann/recursion-context
 */
final class Context
{
    /**
     * @var array[]
     */
    private $arrays;
    /**
     * @var \SplObjectStorage
     */
    private $objects;
    /**
     * Initialises the context
     */
    public function __construct()
    {
        $this->arrays  = array();
        $this->objects = new \SplObjectStorage;
    }
    /**
     * Adds a value to the context.
     *
     * @param  array|object $value      The value to add.
     * @return integer|string           The ID of the stored value, either as
     *                                  a string or integer.
     * @throws InvalidArgumentException Thrown if $value is not an array or
     *                                  object
     */
    public function add(&$value)
    {
        if (is_array($value)) {
            return $this->addArray($value);
        }
        else if (is_object($value)) {
            return $this->addObject($value);
        }
        throw new InvalidArgumentException(
            'Only arrays and objects are supported'
        );
    }
    /**
     * Checks if the given value exists within the context.
     *
     * @param  array|object $value  The value to check.
     * @return integer|string|false The string or integer ID of the stored
     *                              value if it has already been seen, or
     *                              false if the value is not stored.
     * @throws InvalidArgumentException Thrown if $value is not an array or
     *                                  object
     */
    public function contains(&$value)
    {
        if (is_array($value)) {
            return $this->containsArray($value);
        }
        else if (is_object($value)) {
            return $this->containsObject($value);
        }
        throw new InvalidArgumentException(
            'Only arrays and objects are supported'
        );
    }
    /**
     * @param  array $array
     * @return bool|int
     */
    private function addArray(array &$array)
    {
        $key = $this->containsArray($array);
        if ($key !== false) {
            return $key;
        }
        $this->arrays[] = &$array;
        return count($this->arrays) - 1;
    }
    /**
     * @param  object $object
     * @return string
     */
    private function addObject($object)
    {
        if (!$this->objects->contains($object)) {
            $this->objects->attach($object);
        }
        return spl_object_hash($object);
    }
    /**
     * @param  array $array
     * @return integer|false
     */
    private function containsArray(array &$array)
    {
        $keys = array_keys($this->arrays, $array, true);
        $hash = '_Key_' . hash('sha512', microtime(true));
        foreach ($keys as $key) {
            $this->arrays[$key][$hash] = $hash;
            if (isset($array[$hash]) && $array[$hash] === $hash) {
                unset($this->arrays[$key][$hash]);
                return $key;
            }
            unset($this->arrays[$key][$hash]);
        }
        return false;
    }
    /**
     * @param  object $value
     * @return string|false
     */
    private function containsObject($value)
    {
        if ($this->objects->contains($value)) {
            return spl_object_hash($value);
        }
        return false;
    }
}