Query::__construct() - 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

Query::__construct() A

↳ Parent: Query

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2

Importance

Changes	5
Bugs	0	Features	0

Metric	Value
c	5
b	0
f	0
dl	0
loc	6
ccs	5
cts	5
cp	1
rs	9.4285
cc	2
eloc	3
nc	2
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\Query as QueryInterface;
use League\Uri\QueryParser;
use League\Uri\Types\ImmutableCollectionTrait;
use League\Uri\Types\ImmutableComponentTrait;

/**
 * Value object representing a URI query component.
 *
 * @package League.uri
 * @author  Ignace Nyamagana Butera <[email protected]>
 * @since   1.0.0
 */
class Query implements QueryInterface
{
    use ImmutableComponentTrait;

    use ImmutableCollectionTrait;

    /**
     * Key/pair separator character
     *
     * @var string
     */
    protected static $separator = '&';

    /**
     * a new instance
     *
     * @param string $data
     */
    public function __construct($data = null)
    {
        if (null !== $data) {
            $this->data = $this->validate($data);
        }
    }

    /**
     * sanitize the submitted data
     *
     * @param string $str
     *
     * @throws InvalidArgumentException If reserved characters are used
     *
     * @return array
     */
    protected function validate($str)
    {
        $str = $this->validateString($str);
        if (strpos($str, '#') !== false) {
            throw new InvalidArgumentException('the query string must not contain a URI fragment');
        }

        return (new QueryParser())->parse($str, static::$separator, false);
    }

    /**
     * return a new Query instance from an Array or a traversable object
     *
     * @param \Traversable|array $data
     *
     * @return static
     */
    public static function createFromArray($data)
    {
        $query = (new QueryParser())->build(
            static::validateIterator($data),
            static::$separator,
            PHP_QUERY_RFC3986
        );

        return new static($query);
    }

    /**
     * Returns the instance string representation; If the
     * instance is not defined an empty string is returned
     *
     * @return string
     */
    public function __toString()
    {
        return (new QueryParser())->build($this->data, static::$separator, PHP_QUERY_RFC3986);
    }

    /**
     * Returns the instance string representation
     * with its optional URI delimiters
     *
     * @return string
     */
    public function getUriComponent()
    {
        $query = $this->__toString();
        if ('' !== $query) {
            $query = QueryInterface::DELIMITER.$query;
        }

        return $query;
    }

    /**
     * Retrieves a single query parameter.
     *
     * Retrieves a single query parameter. If the parameter has not been set,
     * returns the default value provided.
     *
     * @param string $offset  the parameter name
     * @param mixed  $default Default value to return if the parameter does not exist.
     *
     * @return mixed
     */
    public function getValue($offset, $default = null)
    {
        $offset = rawurldecode($offset);
        if (isset($this->data[$offset])) {
            return $this->data[$offset];
        }

        return $default;
    }

    /**
     * Returns an instance merge with the specified query
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the modified query
     *
     * @param Query|string $query the data to be merged query can be
     *                            - another Interfaces\Query object
     *                            - a string or a Stringable object
     *
     * @return static
     */
    public function merge($query)
    {
        if (!$query instanceof QueryInterface) {
            $query = static::createFromArray($this->validate($query));
        }

        if ($this->sameValueAs($query)) {
            return $this;
        }

        return static::createFromArray(array_merge($this->toArray(), $query->toArray()));
    }

    /**
     * Sort the query string by offset, maintaining offset to data correlations.
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the modified query
     *
     * @param callable|int $sort a PHP sort flag constant or a comparaison function
     *                           which must return an integer less than, equal to,
     *                           or greater than zero if the first argument is
     *                           considered to be respectively less than, equal to,
     *                           or greater than the second.
     *
     * @return static
     */
    public function ksort($sort = SORT_REGULAR)
    {
        $func = is_callable($sort) ? 'uksort' : 'ksort';
        $data = $this->data;
        $func($data, $sort);
        if ($data === $this->data) {
            return $this;
        }

        return static::createFromArray($data);
    }

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

        return static::createFromArray($data);
    }

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


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\Query as QueryInterface;
16		use League\Uri\QueryParser;
17		use League\Uri\Types\ImmutableCollectionTrait;
18		use League\Uri\Types\ImmutableComponentTrait;
19
20		/**
21		* Value object representing a URI query component.
22		*
23		* @package League.uri
24		* @author Ignace Nyamagana Butera <[email protected]>
25		* @since 1.0.0
26		*/
27		class Query implements QueryInterface
28		{
29		use ImmutableComponentTrait;
30
31		use ImmutableCollectionTrait;
32
33		/**
34		* Key/pair separator character
35		*
36		* @var string
37		*/
38		protected static $separator = '&';
39
40		/**
41		* a new instance
42		*
43		* @param string $data
44		*/
45	484	public function __construct($data = null)
46		{
47	484	if (null !== $data) {
48	386	$this->data = $this->validate($data);
49	386	}
50	484	}
51
52		/**
53		* sanitize the submitted data
54		*
55		* @param string $str
56		*
57		* @throws InvalidArgumentException If reserved characters are used
58		*
59		* @return array
60		*/
61	386	protected function validate($str)
62		{
63	386	$str = $this->validateString($str);
64	386	if (strpos($str, '#') !== false) {
65	2	throw new InvalidArgumentException('the query string must not contain a URI fragment');
66		}
67
68	386	return (new QueryParser())->parse($str, static::$separator, false);
69		}
70
71		/**
72		* return a new Query instance from an Array or a traversable object
73		*
74		* @param \Traversable\|array $data
75		*
76		* @return static
77		*/
78	60	public static function createFromArray($data)
79		{
80	60	$query = (new QueryParser())->build(
81	60	static::validateIterator($data),
82	56	static::$separator,
83		PHP_QUERY_RFC3986
84	56	);
85
86	56	return new static($query);
87		}
88
89		/**
90		* Returns the instance string representation; If the
91		* instance is not defined an empty string is returned
92	422	*
93		* @return string
94	422	*/
95		public function __toString()
96		{
97		return (new QueryParser())->build($this->data, static::$separator, PHP_QUERY_RFC3986);
98		}
99
100	390	/**
101		* Returns the instance string representation
102	390	* with its optional URI delimiters
103	390	*
104	286	* @return string
105	286	*/
106		public function getUriComponent()
107	390	{
108		$query = $this->__toString();
109		if ('' !== $query) {
110		$query = QueryInterface::DELIMITER.$query;
111		}
112
113	6	return $query;
114		}
115	6
116	6	/**
117	2	* Retrieves a single query parameter.
118		*
119		* Retrieves a single query parameter. If the parameter has not been set,
120	4	* returns the default value provided.
121		*
122		* @param string $offset the parameter name
123		* @param mixed $default Default value to return if the parameter does not exist.
124		*
125		* @return mixed
126	16	*/
127		public function getValue($offset, $default = null)
128	16	{
129	4	$offset = rawurldecode($offset);
130	4	if (isset($this->data[$offset])) {
131		return $this->data[$offset];
132	16	}
133	2
134		return $default;
135		}
136	14
137		/**
138		* Returns an instance merge with the specified query
139		*
140		* This method MUST retain the state of the current instance, and return
141		* an instance that contains the modified query
142	28	*
143		* @param Query\|string $query the data to be merged query can be
144	28	* - another Interfaces\Query object
145	28	* - a string or a Stringable object
146	28	*
147	28	* @return static
148	20	*/
149		public function merge($query)
150		{
151	8	if (!$query instanceof QueryInterface) {
152		$query = static::createFromArray($this->validate($query));
153		}
154
155		if ($this->sameValueAs($query)) {
156		return $this;
157		}
158
159		return static::createFromArray(array_merge($this->toArray(), $query->toArray()));
160		}
161	28
162		/**
163	28	* Sort the query string by offset, maintaining offset to data correlations.
164	10	*
165		* This method MUST retain the state of the current instance, and return
166		* an instance that contains the modified query
167	18	*
168		* @param callable\|int $sort a PHP sort flag constant or a comparaison function
169		* which must return an integer less than, equal to,
170		* or greater than zero if the first argument is
171		* considered to be respectively less than, equal to,
172		* or greater than the second.
173		*
174		* @return static
175		*/
176		public function ksort($sort = SORT_REGULAR)
177		{
178		$func = is_callable($sort) ? 'uksort' : 'ksort';
179		$data = $this->data;
180		$func($data, $sort);
181		if ($data === $this->data) {
182		return $this;
183		}
184
185		return static::createFromArray($data);
186		}
187
188		/**
189		* Return a new instance when needed
190		*
191		* @param array $data
192		*
193		* @return static
194		*/
195		protected function newCollectionInstance(array $data)
196		{
197		if ($data == $this->data) {
198		return $this;
199		}
200
201		return static::createFromArray($data);
202		}
203
204		/**
205		* @inheritdoc
206		*/
207		public static function __set_state(array $properties)
208		{
209		return static::createFromArray($properties['data']);
210		}
211		}
212

thephpleague / uri

Pull Request — master (#40)

Query::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like