RequestParser::setFilter() - Code Metrics - Inspection of "Merge pull request #2 from mrcnpdlk/devel" - mrcnpdlk/url-search-parser - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b48ee5...2869e6 )

by Marcin

created 2019-01-29 16:41 UTC

RequestParser::setFilter() A

↳ Parent: RequestParser

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php
/**
 * Created by Marcin.
 * Date: 16.06.2018
 * Time: 13:45
 */
declare(strict_types=1);

namespace mrcnpdlk\Lib\UrlSearchParser;


use mrcnpdlk\Lib\UrlSearchParser\Criteria\Filter;
use mrcnpdlk\Lib\UrlSearchParser\Criteria\Sort;
use mrcnpdlk\Lib\UrlSearchParser\Exception\EmptyParamException;
use mrcnpdlk\Lib\UrlSearchParser\Exception\InvalidParamException;

class RequestParser
{
    public const SORT_IDENTIFIER   = 'sort';
    public const FILTER_IDENTIFIER = 'filter';

    public const LIMIT_IDENTIFIER  = 'limit';
    public const OFFSET_IDENTIFIER = 'offset';
    public const PAGE_IDENTIFIER   = 'page';
    public const PHRASE_IDENTIFIER = 'phrase';

    /**
     * @var string
     */
    private $query;
    /**
     * @var array
     */
    private $queryParams = [];
    /**
     * @var \mrcnpdlk\Lib\UrlSearchParser\Criteria\Sort
     */
    private $sort;
    /**
     * @var \mrcnpdlk\Lib\UrlSearchParser\Criteria\Filter
     */
    private $filter;
    /**
     * @var integer|null
     */
    private $limit;
    /**
     * @var integer|null
     */
    private $page;
    /**
     * @var integer|null
     */
    private $offset;
    /**
     * @var string|null
     */
    private $phrase;

    /**
     * RequestParser constructor.
     *
     * @param string $query
     *
     * @throws Exception
     * @throws EmptyParamException
     * @throws InvalidParamException
     */
    public function __construct(string $query)
    {
        $this->query = $query;
        $this->parse($query);
    }

    /**
     * @return \mrcnpdlk\Lib\UrlSearchParser\Criteria\Filter
     */
    public function getFilter(): Filter
    {
        return $this->filter;
    }

    /**
     * @param int|null $default
     *
     * @return int|null
     */
    public function getLimit(int $default = null): ?int
    {
        return $this->limit ?? $default;
    }

    /**
     * @param int|null $default
     *
     * @return int|null
     */
    public function getOffset(int $default = null): ?int
    {
        return $this->offset ?? $default;
    }

    /**
     * @param int|null $default
     *
     * @return int|null
     */
    public function getPage(int $default = null): ?int
    {
        return $this->page ?? $default;
    }

    /**
     * @return null|string
     */
    public function getPhrase(): ?string
    {
        return $this->phrase;
    }

    /**
     * @return string
     */
    public function getQuery(): string
    {
        return $this->query;
    }

    /**
     * @return string
     */
    public function getQueryHash(): string
    {
        return md5(json_encode($this->queryParams));
    }

    /**
     * @param string      $param
     * @param string|null $type If NULL return value AS IS
     * @param mixed|null  $default
     *
     * @return mixed|null
     */
    public function getQueryParam(string $param, string $type = null, $default = null)
    {
        if (isset($this->queryParams[$param])) {
            if ($type !== null) {
                $type = strtolower($type);
                if (!\in_array($type, ['boolean', 'bool', 'integer', 'int', 'float', 'double', 'string', 'array'])) {
                    throw new \InvalidArgumentException(sprintf('Unsupported type [%s]', $type));
                }

                $var = $this->queryParams[$param];

                if ($type === 'array' && \is_string($var)) {
                    $var = explode(',', $var);
                } elseif ($type === 'string' && \is_array($var)) {
                    $var = implode(',', $var);
                } elseif (\in_array($type, ['boolean', 'bool']) && \in_array(strtolower($var), ['true', 'false'])) {
                    $var = (strtolower($var) === 'true');
                } elseif (!settype($var, $type)) {
                    throw new \RuntimeException(sprintf('Cannot set type [%s]', $type));
                }

                return $var;
            }

            return $this->queryParams[$param];
        }

        return $default ?? null;
    }

    /**
     * @return \mrcnpdlk\Lib\UrlSearchParser\Criteria\Sort
     */
    public function getSort(): Sort
    {
        return $this->sort;
    }

    /**
     * @param string $param
     *
     * @return $this
     */
    public function removeQueryParam(string $param): self
    {
        unset($this->queryParams[$param]);

        return $this;
    }

    /**
     * @param \mrcnpdlk\Lib\UrlSearchParser\Criteria\Filter $filter
     *
     * @return $this
     */
    public function setFilter(Filter $filter): self
    {
        $this->filter = $filter;

        return $this;
    }

    /**
     * @param int|null $limit
     *
     * @return $this
     * @throws \mrcnpdlk\Lib\UrlSearchParser\Exception\InvalidParamException
     */
    public function setLimit(?int $limit): self
    {
        $this->limit = $limit;
        if (null !== $this->limit && $this->limit < 0) {
            throw new InvalidParamException('Limit value cannot be lower than 0');
        }

        return $this;
    }

    /**
     * @param int|null $offset
     *
     * @return $this
     * @throws \mrcnpdlk\Lib\UrlSearchParser\Exception\InvalidParamException
     */
    public function setOffset(?int $offset): self
    {
        $this->offset = $offset;
        if (null !== $this->offset && $this->offset < 0) {
            throw new InvalidParamException('Offset value cannot be lower than 0');
        }

        return $this;
    }

    /**
     * @param int|null $page
     *
     * @return $this
     * @throws \mrcnpdlk\Lib\UrlSearchParser\Exception\InvalidParamException
     */
    public function setPage(?int $page): self
    {
        $this->page = $page;
        if (null !== $this->page && $this->page < 0) {
            throw new InvalidParamException('Page value cannot be lower than 0');
        }

        return $this;
    }

    /**
     * @param string|null $phrase
     *
     * @return $this
     */
    public function setPhrase(?string $phrase): self
    {
        $this->phrase = $phrase;

        return $this;
    }

    /**
     * @param \mrcnpdlk\Lib\UrlSearchParser\Criteria\Sort $sort
     *
     * @return $this
     */
    public function setSort(Sort $sort): self
    {
        $this->sort = $sort;

        return $this;
    }

    /**
     * @param string $query
     *
     * @throws \mrcnpdlk\Lib\UrlSearchParser\Exception\EmptyParamException
     * @throws \mrcnpdlk\Lib\UrlSearchParser\Exception\InvalidParamException
     */
    private function parse(string $query): void
    {
        parse_str($query, $this->queryParams);

        $this->setSort(new Sort($this->getQueryParam(self::SORT_IDENTIFIER, 'string')));
        $this->setFilter(new Filter($this->getQueryParam(self::FILTER_IDENTIFIER, 'array', [])));
        $this->setLimit($this->getQueryParam('limit', 'int'));
        $this->setOffset($this->getQueryParam('offset', 'int'));
        $this->setPage($this->getQueryParam('page', 'int'));
        $this->setPhrase($this->getQueryParam('phrase', 'string'));
    }

}


1		<?php
2		/**
3		* Created by Marcin.
4		* Date: 16.06.2018
5		* Time: 13:45
6		*/
7		declare(strict_types=1);
8
9		namespace mrcnpdlk\Lib\UrlSearchParser;
10
11
12		use mrcnpdlk\Lib\UrlSearchParser\Criteria\Filter;
13		use mrcnpdlk\Lib\UrlSearchParser\Criteria\Sort;
14		use mrcnpdlk\Lib\UrlSearchParser\Exception\EmptyParamException;
15		use mrcnpdlk\Lib\UrlSearchParser\Exception\InvalidParamException;
16
17		class RequestParser
18		{
19		public const SORT_IDENTIFIER = 'sort';
20		public const FILTER_IDENTIFIER = 'filter';
21
22		public const LIMIT_IDENTIFIER = 'limit';
23		public const OFFSET_IDENTIFIER = 'offset';
24		public const PAGE_IDENTIFIER = 'page';
25		public const PHRASE_IDENTIFIER = 'phrase';
26
27		/**
28		* @var string
29		*/
30		private $query;
31		/**
32		* @var array
33		*/
34		private $queryParams = [];
35		/**
36		* @var \mrcnpdlk\Lib\UrlSearchParser\Criteria\Sort
37		*/
38		private $sort;
39		/**
40		* @var \mrcnpdlk\Lib\UrlSearchParser\Criteria\Filter
41		*/
42		private $filter;
43		/**
44		* @var integer\|null
45		*/
46		private $limit;
47		/**
48		* @var integer\|null
49		*/
50		private $page;
51		/**
52		* @var integer\|null
53		*/
54		private $offset;
55		/**
56		* @var string\|null
57		*/
58		private $phrase;
59
60		/**
61		* RequestParser constructor.
62		*
63		* @param string $query
64		*
65		* @throws Exception
66		* @throws EmptyParamException
67		* @throws InvalidParamException
68		*/
69	20	public function __construct(string $query)
70		{
71	20	$this->query = $query;
72	20	$this->parse($query);
73	11	}
74
75		/**
76		* @return \mrcnpdlk\Lib\UrlSearchParser\Criteria\Filter
77		*/
78	4	public function getFilter(): Filter
79		{
80	4	return $this->filter;
81		}
82
83		/**
84		* @param int\|null $default
85		*
86		* @return int\|null
87		*/
88	2	public function getLimit(int $default = null): ?int
89		{
90	2	return $this->limit ?? $default;
91		}
92
93		/**
94		* @param int\|null $default
95		*
96		* @return int\|null
97		*/
98	2	public function getOffset(int $default = null): ?int
99		{
100	2	return $this->offset ?? $default;
101		}
102
103		/**
104		* @param int\|null $default
105		*
106		* @return int\|null
107		*/
108	2	public function getPage(int $default = null): ?int
109		{
110	2	return $this->page ?? $default;
111		}
112
113		/**
114		* @return null\|string
115		*/
116	2	public function getPhrase(): ?string
117		{
118	2	return $this->phrase;
119		}
120
121		/**
122		* @return string
123		*/
124		public function getQuery(): string
125		{
126		return $this->query;
127		}
128
129		/**
130		* @return string
131		*/
132		public function getQueryHash(): string
133		{
134		return md5(json_encode($this->queryParams));
135		}
136
137		/**
138		* @param string $param
139		* @param string\|null $type If NULL return value AS IS
140		* @param mixed\|null $default
141		*
142		* @return mixed\|null
143		*/
144	20	public function getQueryParam(string $param, string $type = null, $default = null)
145		{
146	20	if (isset($this->queryParams[$param])) {
147	20	if ($type !== null) {
148	19	$type = strtolower($type);
149	19	if (!\in_array($type, ['boolean', 'bool', 'integer', 'int', 'float', 'double', 'string', 'array'])) {
150	1	throw new \InvalidArgumentException(sprintf('Unsupported type [%s]', $type));
151		}
152
153	18	$var = $this->queryParams[$param];
154
155	18	if ($type === 'array' && \is_string($var)) {
156	2	$var = explode(',', $var);
157	17	} elseif ($type === 'string' && \is_array($var)) {
158	1	$var = implode(',', $var);
159	17	} elseif (\in_array($type, ['boolean', 'bool']) && \in_array(strtolower($var), ['true', 'false'])) {
160	2	$var = (strtolower($var) === 'true');
161	17	} elseif (!settype($var, $type)) {
162		throw new \RuntimeException(sprintf('Cannot set type [%s]', $type));
163		}
164
165	18	return $var;
166		}
167
168	1	return $this->queryParams[$param];
169		}
170
171	18	return $default ?? null;
172		}
173
174		/**
175		* @return \mrcnpdlk\Lib\UrlSearchParser\Criteria\Sort
176		*/
177	2	public function getSort(): Sort
178		{
179	2	return $this->sort;
180		}
181
182		/**
183		* @param string $param
184		*
185		* @return $this
186		*/
187	1	public function removeQueryParam(string $param): self
188		{
189	1	unset($this->queryParams[$param]);
190
191	1	return $this;
192		}
193
194		/**
195		* @param \mrcnpdlk\Lib\UrlSearchParser\Criteria\Filter $filter
196		*
197		* @return $this
198		*/
199	14	public function setFilter(Filter $filter): self
200		{
201	14	$this->filter = $filter;
202
203	14	return $this;
204		}
205
206		/**
207		* @param int\|null $limit
208		*
209		* @return $this
210		* @throws \mrcnpdlk\Lib\UrlSearchParser\Exception\InvalidParamException
211		*/
212	14	public function setLimit(?int $limit): self
213		{
214	14	$this->limit = $limit;
215	14	if (null !== $this->limit && $this->limit < 0) {
216	1	throw new InvalidParamException('Limit value cannot be lower than 0');
217		}
218
219	13	return $this;
220		}
221
222		/**
223		* @param int\|null $offset
224		*
225		* @return $this
226		* @throws \mrcnpdlk\Lib\UrlSearchParser\Exception\InvalidParamException
227		*/
228	13	public function setOffset(?int $offset): self
229		{
230	13	$this->offset = $offset;
231	13	if (null !== $this->offset && $this->offset < 0) {
232	1	throw new InvalidParamException('Offset value cannot be lower than 0');
233		}
234
235	12	return $this;
236		}
237
238		/**
239		* @param int\|null $page
240		*
241		* @return $this
242		* @throws \mrcnpdlk\Lib\UrlSearchParser\Exception\InvalidParamException
243		*/
244	12	public function setPage(?int $page): self
245		{
246	12	$this->page = $page;
247	12	if (null !== $this->page && $this->page < 0) {
248	1	throw new InvalidParamException('Page value cannot be lower than 0');
249		}
250
251	11	return $this;
252		}
253
254		/**
255		* @param string\|null $phrase
256		*
257		* @return $this
258		*/
259	11	public function setPhrase(?string $phrase): self
260		{
261	11	$this->phrase = $phrase;
262
263	11	return $this;
264		}
265
266		/**
267		* @param \mrcnpdlk\Lib\UrlSearchParser\Criteria\Sort $sort
268		*
269		* @return $this
270		*/
271	18	public function setSort(Sort $sort): self
272		{
273	18	$this->sort = $sort;
274
275	18	return $this;
276		}
277
278		/**
279		* @param string $query
280		*
281		* @throws \mrcnpdlk\Lib\UrlSearchParser\Exception\EmptyParamException
282		* @throws \mrcnpdlk\Lib\UrlSearchParser\Exception\InvalidParamException
283		*/
284	20	private function parse(string $query): void
285		{
286	20	parse_str($query, $this->queryParams);
287
288	20	$this->setSort(new Sort($this->getQueryParam(self::SORT_IDENTIFIER, 'string')));
289	18	$this->setFilter(new Filter($this->getQueryParam(self::FILTER_IDENTIFIER, 'array', [])));
290	14	$this->setLimit($this->getQueryParam('limit', 'int'));
291	13	$this->setOffset($this->getQueryParam('offset', 'int'));
292	12	$this->setPage($this->getQueryParam('page', 'int'));
293	11	$this->setPhrase($this->getQueryParam('phrase', 'string'));
294	11	}
295
296		}
297

mrcnpdlk / url-search-parser

Push — master ( b48ee5...2869e6 )

RequestParser::setFilter() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like