Query::__debugInfo() - Code Metrics - Inspection of "Merge pull request #46 from thephpleague/features/..." - thephpleague/uri - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0cbce9...ce80be )

by ignace nyamagana

created 2016-04-12 19:09 UTC

Query::__debugInfo() A

↳ Parent: Query

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?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.1
 * @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);
    }

    /**
     * @inheritdoc
     */
    public function __debugInfo()
    {
        return ['query' => $this->__toString()];
    }

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

    /**
     * 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);
    }
}


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.1
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	754	public function __construct($data = null)
46		{
47	754	if (null !== $data) {
48	607	$this->data = $this->validate($data);
49	404	}
50	754	}
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	607	protected function validate($str)
62		{
63	607	$str = $this->validateString($str);
64	607	if (strpos($str, '#') !== false) {
65	3	throw new InvalidArgumentException('the query string must not contain a URI fragment');
66		}
67
68	607	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	102	public static function createFromArray($data)
79		{
80	102	$query = (new QueryParser())->build(
81	102	static::validateIterator($data),
82	96	static::$separator,
83	32	PHP_QUERY_RFC3986
84	64	);
85
86	96	return new static($query);
87		}
88
89		/**
90		* @inheritdoc
91		*/
92	2	public function __debugInfo()
93		{
94	2	return ['query' => $this->__toString()];
95		}
96
97		/**
98		* @inheritdoc
99		*/
100	12	public static function __set_state(array $properties)
101		{
102	12	return static::createFromArray($properties['data']);
103		}
104
105		/**
106		* Returns the instance string representation; If the
107		* instance is not defined an empty string is returned
108		*
109		* @return string
110		*/
111	661	public function __toString()
112		{
113	661	return (new QueryParser())->build($this->data, static::$separator, PHP_QUERY_RFC3986);
114		}
115
116		/**
117		* Returns the instance string representation
118		* with its optional URI delimiters
119		*
120		* @return string
121		*/
122	611	public function getUriComponent()
123		{
124	611	$query = $this->__toString();
125	611	if ('' !== $query) {
126	443	$query = QueryInterface::DELIMITER.$query;
127	295	}
128
129	611	return $query;
130		}
131
132		/**
133		* Retrieves a single query parameter.
134		*
135		* Retrieves a single query parameter. If the parameter has not been set,
136		* returns the default value provided.
137		*
138		* @param string $offset the parameter name
139		* @param mixed $default Default value to return if the parameter does not exist.
140		*
141		* @return mixed
142		*/
143	9	public function getValue($offset, $default = null)
144		{
145	9	$offset = rawurldecode($offset);
146	9	if (isset($this->data[$offset])) {
147	3	return $this->data[$offset];
148		}
149
150	6	return $default;
151		}
152
153		/**
154		* Returns an instance merge with the specified query
155		*
156		* This method MUST retain the state of the current instance, and return
157		* an instance that contains the modified query
158		*
159		* @param Query\|string $query the data to be merged query can be
160		* - another Interfaces\Query object
161		* - a string or a Stringable object
162		*
163		* @return static
164		*/
165	24	public function merge($query)
166		{
167	24	if (!$query instanceof QueryInterface) {
168	6	$query = static::createFromArray($this->validate($query));
169	4	}
170
171	24	if ($this->sameValueAs($query)) {
172	3	return $this;
173		}
174
175	21	return static::createFromArray(array_merge($this->toArray(), $query->toArray()));
176		}
177
178		/**
179		* Sort the query string by offset, maintaining offset to data correlations.
180		*
181		* This method MUST retain the state of the current instance, and return
182		* an instance that contains the modified query
183		*
184		* @param callable\|int $sort a PHP sort flag constant or a comparaison function
185		* which must return an integer less than, equal to,
186		* or greater than zero if the first argument is
187		* considered to be respectively less than, equal to,
188		* or greater than the second.
189		*
190		* @return static
191		*/
192	45	public function ksort($sort = SORT_REGULAR)
193		{
194	45	$func = is_callable($sort) ? 'uksort' : 'ksort';
195	45	$data = $this->data;
196	45	$func($data, $sort);
197	45	if ($data === $this->data) {
198	33	return $this;
199		}
200
201	12	return static::createFromArray($data);
202		}
203
204		/**
205		* Return a new instance when needed
206		*
207		* @param array $data
208		*
209		* @return static
210		*/
211	42	protected function newCollectionInstance(array $data)
212		{
213	42	if ($data == $this->data) {
214	15	return $this;
215		}
216
217	27	return static::createFromArray($data);
218		}
219		}
220

thephpleague / uri

Push — master ( 0cbce9...ce80be )

Query::__debugInfo() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like