mrcnpdlk\Lib\UrlSearchParser\RequestParser

Complexity

Total Complexity

23

Size/Duplication

Total Lines	165
Duplicated Lines	0 %

Test Coverage

Coverage

95.56%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getPhrase()	0	3	1
A	__construct()	0	3	1
B	parse()	0	19	7
D	getQueryParam()	0	26	9
A	getFilter()	0	3	1
A	getLimit()	0	3	1
A	getOffset()	0	3	1
A	getPage()	0	3	1
A	getSort()	0	3	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\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';


	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 \mrcnpdlk\Lib\UrlSearchParser\Exception
	 * @throws \mrcnpdlk\Lib\UrlSearchParser\Exception\EmptyParamException
	 * @throws \mrcnpdlk\Lib\UrlSearchParser\Exception\InvalidParamException
	 */
	public function __construct(string $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;
	}

	/**
	 * @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 (!settype($var, strtolower($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 $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->sort   = new Sort($this->getQueryParam(self::SORT_IDENTIFIER, 'string'));
		$this->filter = new Filter($this->getQueryParam(self::FILTER_IDENTIFIER, 'array', []));
		$this->limit  = $this->getQueryParam('limit', 'int');
		if (null !== $this->limit && $this->limit < 0) {
			throw new InvalidParamException('Limit value cannot be lower than 0');
		}
		$this->offset = $this->getQueryParam('offset', 'int');
		if (null !== $this->offset && $this->offset < 0) {
			throw new InvalidParamException('Offset value cannot be lower than 0');
		}
		$this->page = $this->getQueryParam('page', 'int');
		if (null !== $this->page && $this->page < 0) {
			throw new InvalidParamException('Page value cannot be lower than 0');
		}
		$this->phrase = $this->getQueryParam('phrase', 'string');
	}
}