AbstractHierarchicalComponent::__set_state() - Code Metrics - Inspection of "Adding __debugInfo and __set_state to improve debu..." - thephpleague/uri - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#40)

by ignace nyamagana

created 2016-03-16 16:04 UTC

AbstractHierarchicalComponent::__set_state() A

↳ Parent: AbstractHierarchicalComponent

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
ccs	0
cts	0
cp	0
rs	10
cc	1
eloc	2
nc	1
nop	1
crap	2

<?php
/**
 * League.Uri (http://uri.thephpleague.com)
 *
 * @package   League.uri
 * @author    Ignace Nyamagana Butera <[email protected]>
 * @copyright 2013-2015 Ignace Nyamagana Butera
 * @license   https://github.com/thephpleague/uri/blob/master/LICENSE (MIT License)
 * @version   4.1.0
 * @link      https://github.com/thephpleague/uri/
 */
namespace League\Uri\Components;

use InvalidArgumentException;
use League\Uri\Interfaces\HierarchicalComponent;
use League\Uri\Types\ImmutableCollectionTrait;
use League\Uri\Types\ImmutableComponentTrait;

/**
 * An abstract class to ease collection like Component object manipulation
 *
 * @package League.uri
 * @author  Ignace Nyamagana Butera <[email protected]>
 * @since   4.0.0
 */
abstract class AbstractHierarchicalComponent implements HierarchicalComponent
{
    use ImmutableCollectionTrait;

    use ImmutableComponentTrait;

    const IS_ABSOLUTE = 1;

    const IS_RELATIVE = 0;

    /**
     * Hierarchical component separator
     *
     * @var string
     */
    protected static $separator;

    /**
     * Is the object considered absolute
     *
     * @var int
     */
    protected $isAbsolute = self::IS_RELATIVE;

    /**
     * new instance
     *
     * @param null|string $str the component value
     */
    abstract public function __construct($str);

    /**
     * Returns whether or not the component is absolute or not
     *
     * @return bool
     */
    public function isAbsolute()
    {
        return $this->isAbsolute == self::IS_ABSOLUTE;
    }

    /**
     * Return a new instance when needed
     *
     * @param array $data
     *
     * @return static
     */
    protected function newCollectionInstance(array $data)
    {
        if ($data == $this->data) {
            return $this;
        }

        return $this->createFromArray($data, $this->isAbsolute);
    }

    /**
     * Returns the instance string representation
     * with its optional URI delimiters
     *
     * @return string
     */
    public function getUriComponent()
    {
        return $this->__toString();
    }

    /**
     * Returns an instance with the specified component prepended
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the modified component with the prepended data
     *
     * @param HierarchicalComponent|string $component the component to prepend
     *
     * @return static
     */
    public function prepend($component)
    {
        return $this->createFromArray(
            $this->validateComponent($component),
            $this->isAbsolute)
        ->append($this);
    }

    /**
     * Returns an instance with the specified component appended
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the modified component with the appended data
     *
     * @param HierarchicalComponent|string $component the component to append
     *
     * @return static
     */
    abstract public function append($component);

    /**
     * Validate a component as a HierarchicalComponentInterface object
     *
     * @param HierarchicalComponent|string $component
     *
     * @return static
     */
    protected function validateComponent($component)
    {
        if (!$component instanceof HierarchicalComponent) {
            return $this->modify($component);
        }

        return $component;
    }

    /**
     * return a new instance from an array or a traversable object
     *
     * @param \Traversable|string[] $data The segments list
     * @param int                   $type one of the constant IS_ABSOLUTE or IS_RELATIVE
     *
     * @throws InvalidArgumentException If $type is not a recognized constant
     *
     * @return static
     */
    public static function createFromArray($data, $type = self::IS_RELATIVE)
    {
        static $type_list = [self::IS_ABSOLUTE => 1, self::IS_RELATIVE => 1];

        if (!isset($type_list[$type])) {
            throw new InvalidArgumentException('Please verify the submitted constant');
        }

        return new static(static::formatComponentString($data, $type));
    }

    /**
     * Return a formatted component string according to its type
     *
     * @param \Traversable|string[] $data The segments list
     * @param int                   $type
     *
     * @throws InvalidArgumentException If $data is invalid
     *
     * @return string
     */
    protected static function formatComponentString($data, $type)
    {
        $path = implode(static::$separator, static::validateIterator($data));
        if (self::IS_ABSOLUTE == $type) {
            return static::$separator.$path;
        }

        return $path;
    }

    /**
     * Returns an instance with the modified segment
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the modified component with the replaced data
     *
     * @param int                          $offset    the label offset to remove and replace by
     *                                                the given component
     * @param HierarchicalComponent|string $component the component added
     *
     * @return static
     */
    public function replace($offset, $component)
    {
        if (!empty($this->data) && !$this->hasKey($offset)) {
            return $this;
        }

        $source = $this->toArray();
        $dest   = $this->validateComponent($component)->toArray();
        if ('' == $dest[count($dest) - 1]) {
            array_pop($dest);
        }

        return $this->newCollectionInstance(
            array_merge(array_slice($source, 0, $offset), $dest, array_slice($source, $offset + 1))
        );
    }

    /**
     * @inheritdoc
     */
    public static function __set_state(array $properties)
    {
        return static::createFromArray($properties['data'], $properties['isAbsolute']);
    }
}


1		<?php
2		/**
3		* League.Uri (http://uri.thephpleague.com)
4		*
5		* @package League.uri
6		* @author Ignace Nyamagana Butera <[email protected]>
7		* @copyright 2013-2015 Ignace Nyamagana Butera
8		* @license https://github.com/thephpleague/uri/blob/master/LICENSE (MIT License)
9		* @version 4.1.0
10		* @link https://github.com/thephpleague/uri/
11		*/
12		namespace League\Uri\Components;
13
14		use InvalidArgumentException;
15		use League\Uri\Interfaces\HierarchicalComponent;
16		use League\Uri\Types\ImmutableCollectionTrait;
17		use League\Uri\Types\ImmutableComponentTrait;
18
19		/**
20		* An abstract class to ease collection like Component object manipulation
21		*
22		* @package League.uri
23		* @author Ignace Nyamagana Butera <[email protected]>
24		* @since 4.0.0
25		*/
26		abstract class AbstractHierarchicalComponent implements HierarchicalComponent
27		{
28		use ImmutableCollectionTrait;
29
30		use ImmutableComponentTrait;
31
32		const IS_ABSOLUTE = 1;
33
34		const IS_RELATIVE = 0;
35
36		/**
37		* Hierarchical component separator
38		*
39		* @var string
40		*/
41		protected static $separator;
42
43		/**
44		* Is the object considered absolute
45		*
46		* @var int
47		*/
48		protected $isAbsolute = self::IS_RELATIVE;
49
50		/**
51		* new instance
52		*
53		* @param null\|string $str the component value
54		*/
55		abstract public function __construct($str);
56
57		/**
58		* Returns whether or not the component is absolute or not
59		*
60	16	* @return bool
61		*/
62	16	public function isAbsolute()
63		{
64		return $this->isAbsolute == self::IS_ABSOLUTE;
65		}
66
67		/**
68		* Return a new instance when needed
69		*
70		* @param array $data
71		*
72	190	* @return static
73		*/
74	190	protected function newCollectionInstance(array $data)
75	4	{
76		if ($data == $this->data) {
77		return $this;
78	186	}
79
80		return $this->createFromArray($data, $this->isAbsolute);
81		}
82
83		/**
84	414	* Returns the instance string representation
85		* with its optional URI delimiters
86	414	*
87		* @return string
88		*/
89		public function getUriComponent()
90		{
91		return $this->__toString();
92	40	}
93
94	40	/**
95	40	* Returns an instance with the specified component prepended
96	40	*
97	40	* This method MUST retain the state of the current instance, and return
98		* an instance that contains the modified component with the prepended data
99		*
100		* @param HierarchicalComponent\|string $component the component to prepend
101		*
102		* @return static
103		*/
104		public function prepend($component)
105		{
106		return $this->createFromArray(
107		$this->validateComponent($component),
108		$this->isAbsolute)
109		->append($this);
110		}
111
112	124	/**
113		* Returns an instance with the specified component appended
114	124	*
115	50	* This method MUST retain the state of the current instance, and return
116		* an instance that contains the modified component with the appended data
117		*
118	90	* @param HierarchicalComponent\|string $component the component to append
119		*
120		* @return static
121		*/
122		abstract public function append($component);
123
124		/**
125		* Validate a component as a HierarchicalComponentInterface object
126		*
127		* @param HierarchicalComponent\|string $component
128		*
129		* @return static
130		*/
131	314	protected function validateComponent($component)
132		{
133	314	if (!$component instanceof HierarchicalComponent) {
134		return $this->modify($component);
135	314	}
136	4
137		return $component;
138		}
139	310
140		/**
141		* return a new instance from an array or a traversable object
142		*
143		* @param \Traversable\|string[] $data The segments list
144		* @param int $type one of the constant IS_ABSOLUTE or IS_RELATIVE
145		*
146		* @throws InvalidArgumentException If $type is not a recognized constant
147		*
148		* @return static
149		*/
150		public static function createFromArray($data, $type = self::IS_RELATIVE)
151		{
152	218	static $type_list = [self::IS_ABSOLUTE => 1, self::IS_RELATIVE => 1];
153
154	218	if (!isset($type_list[$type])) {
155	210	throw new InvalidArgumentException('Please verify the submitted constant');
156	162	}
157
158		return new static(static::formatComponentString($data, $type));
159	48	}
160
161		/**
162		* Return a formatted component string according to its type
163		*
164		* @param \Traversable\|string[] $data The segments list
165	46	* @param int $type
166		*
167	46	* @throws InvalidArgumentException If $data is invalid
168	10	*
169		* @return string
170		*/
171	36	protected static function formatComponentString($data, $type)
172	36	{
173	36	$path = implode(static::$separator, static::validateIterator($data));
174	8	if (self::IS_ABSOLUTE == $type) {
175	8	return static::$separator.$path;
176		}
177	36
178	36	return $path;
179	36	}
180
181		/**
182		* Returns an instance with the modified segment
183		*
184		* This method MUST retain the state of the current instance, and return
185		* an instance that contains the modified component with the replaced data
186		*
187		* @param int $offset the label offset to remove and replace by
188		* the given component
189		* @param HierarchicalComponent\|string $component the component added
190		*
191		* @return static
192		*/
193		public function replace($offset, $component)
194		{
195		if (!empty($this->data) && !$this->hasKey($offset)) {
196		return $this;
197		}
198
199		$source = $this->toArray();
200		$dest = $this->validateComponent($component)->toArray();
201		if ('' == $dest[count($dest) - 1]) {
202		array_pop($dest);
203		}
204
205		return $this->newCollectionInstance(
206		array_merge(array_slice($source, 0, $offset), $dest, array_slice($source, $offset + 1))
207		);
208		}
209
210		/**
211		* @inheritdoc
212		*/
213		public static function __set_state(array $properties)
214		{
215		return static::createFromArray($properties['data'], $properties['isAbsolute']);
216		}
217		}
218

thephpleague / uri

Pull Request — master (#40)

AbstractHierarchicalComponent::__set_state() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like