QueryFilter::getFullSearchBy() - Code Metrics - Inspection of "Fix code quality issues" - artprima/query-filter-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — master ( 9af1c5...729744 )

by Denis

created 2018-03-07 23:30 UTC

QueryFilter::getFullSearchBy() B

↳ Parent: QueryFilter

Complexity

Conditions	7
Paths	4

Size

Total Lines	16
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	7

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Artprima\QueryFilterBundle\QueryFilter;

use Artprima\QueryFilterBundle\Exception\InvalidArgumentException;
use Artprima\QueryFilterBundle\QueryFilter\Config\ConfigInterface;
use Artprima\QueryFilterBundle\Response\ResponseInterface;

/**
 * Class QueryFilter
 *
 * @author Denis Voytyuk <[email protected]>
 */
final class QueryFilter
{
    /**
     * @var string
     */
    private $responseClassName;

    /**
     * QueryFilter constructor.
     * @param string $responseClassName
     * @throws \ReflectionException
     * @throws InvalidArgumentException
     */
    public function __construct(string $responseClassName)
    {
        $refClass = new \ReflectionClass($responseClassName);
        if (!$refClass->implementsInterface(ResponseInterface::class)) {
            throw new InvalidArgumentException(sprintf(
                'Response class "%s" must implement "%s"',
                $responseClassName,
                ResponseInterface::class
            ));
        }

        $constructor = $refClass->getConstructor();
        if ($constructor !== null && $constructor->getNumberOfRequiredParameters() > 0) {
            throw new InvalidArgumentException(sprintf(
                'Response class "%s" must have a constructor without required parameters',
                $responseClassName
            ));
        }

        $this->responseClassName = $responseClassName;
    }

    /**
     * Prepares data to use for sorting and paging
     *
     * Resulting 'sortdata' array element contains associated array where keys are column names and values are order
     * directions (only one array item is supported now, others are ignored). If no sorting provided, default sorting data is used.
     *
     * @return array Resulting array contains two elements 'curpage' and 'sortdata' as keys with corresponding values
     */
    private function getPageData(ConfigInterface $config): array
    {
        $sort = [
            'field' => $config->getRequest()->getSortBy(),
            'type' => $config->getRequest()->getSortDir(),
        ];
        $curPage = $config->getRequest()->getPageNum();

        if ($curPage < 1) {
            $curPage = 1;
        }

        $sortdata = $config->getSortColsDefault();
        if (isset($sort['field'], $sort['type'])) {
            if (in_array($sort['type'], array('asc', 'desc'), true) && in_array($sort['field'], $config->getSortCols(), true)) {
                $sortdata = array($sort['field'] => $sort['type']);
            }
        }

        return array(
            'curpage' => $curPage,
            'sortdata' => $sortdata,
        );
    }

    private function getSimpleSearchBy(array $allowedCols, ?array $search): array
    {
        $searchBy = [];

        if ($search === null) {
            return $searchBy;
        }

        foreach ($search as $key => $val) {
            if (in_array($key, $allowedCols, true) && $val !== null) {
                $searchBy[$key] = array(
                    'type' => 'like',
                    'val' => $val,
                );
                if (strpos($key, 'GroupConcat') !== false) {
                    $searchBy[$key]['having'] = true;
                }
            }
        }

        return $searchBy;
    }

    private function getFullSearchBy(array $allowedCols, ?array $search): array
    {
        $searchBy = [];

        foreach ($search as $data) {
            if (!empty($data) && is_array($data) && isset($data['field']) && in_array($data['field'], $allowedCols, true)) {
                $field = $data['field'];
                unset($data['field']);
                $searchBy[$field] = $data;
                if (strpos($field, 'GroupConcat') !== false) {
                    $searchBy[$field]['having'] = true;
                }
            }
        }

        return $searchBy;
    }

    /**
     * Get searchby data prepared for query builder
     *
     * If simple, $search must be set to:
     * <code>
     *     $this->searchData = array(
     *         'column_name1' => 'search_value1',
     *         'column_name2' => 'search_value2',
     *     );
     * </code>
     * All comparisons will be treated as "like" here.
     *
     * If not simple, $search must be set to:
     * <code>
     *     $this->searchData = array(
     *         array('field' => 'column_name1', 'type' => 'like', 'val' => 'search_value1'),
     *         array('field' => 'column_name2', 'type' => 'eq', 'val' => 'search_value2'),
     *     );
     * </code>
     *
     * For both cases GroupConcat columns the result will receive extra $searchBy["column_name1"]["having"] = true
     *
     * @param array $allowedCols
     * @param array|null $search
     * @param bool $simple
     * @return array
     */
    private function getSearchBy(array $allowedCols, ?array $search, bool $simple): array
    {
        return $simple ? $this->getSimpleSearchBy($allowedCols, $search) : $this->getFullSearchBy($allowedCols, $search);
    }

    /**
     * Gets data for use in twig templates
     *
     * Consists of 8 steps:
     *
     * 1. Builds searchBy (see more: {@link QueryFilter::getSearchBy()}, {@link ConfigInterface::getAllowedCols()},
     *   {@link ConfigInterface::getSearchData()}, {@link ConfigInterface::isSimpleSearch()})
     *
     * 2. Modifies searchBy array with the shortcut expanders (see more: {@link ConfigInterface::getShortcutExpanders()})
     *
     * 3. Adds searchByExtra (if any) to the initial searchBy (see more: {@link ConfigInterface::getSearchByExtra()})
     *
     * 4. Obtains paging and sorting data (see more: {@link QueryFilter::getSortPageData()}, {@link ConfigInterface::getSortCols()},
     *    {@link ConfigInterface::getCurPage()}, {@link ConfigInterface::getSortBy()},
     *    {@link ConfigInterface::getSortColsDefault()})
     *
     * 5. Obtains data to according to the conditions defined in steps 1-4 (see more:
     *    {@link ConfigInterface::getRepositoryCallback()}, {@link ConfigInterface::getItemsPerPage})
     *
     * 6. Prepares and retuns the response
     *
     * @todo: refactor to smaller parts
     *
     * @return ResponseInterface
     * @throws InvalidArgumentException
     */
    public function getData(ConfigInterface $config): ResponseInterface
    {
        // 1. Get  search by from query params limited by specified search by keys
        $searchBy = $this->getSearchBy(
            $config->getSearchAllowedCols(),
            $config->getRequest()->getQuery(),
            $config->getRequest()->isSimple()
        );

        // (optional) 2. replace search by shortcut(s) with more complicated expressions  // **
        $aliases = $config->getSearchByAliases();
        foreach ($aliases as $alias => $value) {
            if (!empty($searchBy[$alias])) {
                if (!empty($value['data'])) {
                    $searchBy[$value['name']] = $value['data'];
                    $searchBy[$value['name']]['val'] = $searchBy[$alias]['val'];
                } else {
                    $searchBy[$value['name']] = $searchBy[$alias];
                }
                unset($searchBy[$alias]);
            }
        }

        // (optional) 3. Set search extra filters (can be used to display entries for one particular entity,
        //               or to add some extra conditions/filterings)
        $searchByExtra = $config->getSearchByExtra();
        if (!empty($searchByExtra)) {
            if (is_object($searchByExtra) && ($searchByExtra instanceof \Closure)) {

                $searchByExtra = $searchByExtra($searchBy);
            }
            $searchBy = array_merge($searchBy, $searchByExtra);
        }

        // 4. Obtain paging and sorting data
        $pageData = $this->getPageData($config);

        // 4.5 Replace spaces by %
        foreach ($searchBy as &$item) {
            if (is_array($item) && isset($item['type'], $item['val']) && ($item['type'] === 'like') && preg_match('/[\s\.,]+/', $item['val'])) {
                $words = preg_split('/[\s\.,]+/', $item['val']);
                $item['val'] = $words ? implode('%', $words) : $item['val'];
            }
        }
        unset($item);

        // 5. Query database to obtain corresponding entities
        $repositoryCallback = $config->getRepositoryCallback();
        if (!\is_callable($repositoryCallback)) {
            throw new InvalidArgumentException('Repository callback is not callable');
        }
        $itemsPerPage = $config->getRequest()->getLimit();
        $args = (new QueryFilterArgs())
            ->setSearchBy($searchBy)
            ->setSortBy($pageData['sortdata'])
            ->setLimit($itemsPerPage)
            ->setOffset(($pageData['curpage'] - 1) * $itemsPerPage);

        // $repositoryCallback can be an array, but since PHP 7.0 it's possible to use it as a function directly
        // i.e. without using call_user_func[_array]().
        // For the reference: https://trowski.com/2015/06/20/php-callable-paradox/
        $startTime = microtime(true);
        $filterData = $repositoryCallback($args);
        $duration = microtime(true) - $startTime;
        if (!$filterData instanceof QueryResult) {
            throw new InvalidArgumentException('Repository callback must return an instance of QueryResult');
        }

        // 6. Prepare the data
        /** @var ResponseInterface $response */
        $response = new $this->responseClassName;
        $response->setData($filterData->getResult());
        $response->addMeta('total_records', $filterData->getTotalRows());
        $response->addMeta('metrics', array(
            'query_and_transformation' => $duration,
        ));

        // 7. Return the data
        return $response;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Artprima\QueryFilterBundle\QueryFilter;
6
7		use Artprima\QueryFilterBundle\Exception\InvalidArgumentException;
8		use Artprima\QueryFilterBundle\QueryFilter\Config\ConfigInterface;
9		use Artprima\QueryFilterBundle\Response\ResponseInterface;
10
11		/**
12		* Class QueryFilter
13		*
14		* @author Denis Voytyuk <[email protected]>
15		*/
16		final class QueryFilter
17		{
18		/**
19		* @var string
20		*/
21		private $responseClassName;
22
23		/**
24		* QueryFilter constructor.
25		* @param string $responseClassName
26		* @throws \ReflectionException
27		* @throws InvalidArgumentException
28		*/
29	4	public function __construct(string $responseClassName)
30		{
31	4	$refClass = new \ReflectionClass($responseClassName);
32	4	if (!$refClass->implementsInterface(ResponseInterface::class)) {
33	1	throw new InvalidArgumentException(sprintf(
34	1	'Response class "%s" must implement "%s"',
35	1	$responseClassName,
36	1	ResponseInterface::class
37		));
38		}
39
40	3	$constructor = $refClass->getConstructor();
41	3	if ($constructor !== null && $constructor->getNumberOfRequiredParameters() > 0) {
42	1	throw new InvalidArgumentException(sprintf(
43	1	'Response class "%s" must have a constructor without required parameters',
44	1	$responseClassName
45		));
46		}
47
48	2	$this->responseClassName = $responseClassName;
49	2	}
50
51		/**
52		* Prepares data to use for sorting and paging
53		*
54		* Resulting 'sortdata' array element contains associated array where keys are column names and values are order
55		* directions (only one array item is supported now, others are ignored). If no sorting provided, default sorting data is used.
56		*
57		* @return array Resulting array contains two elements 'curpage' and 'sortdata' as keys with corresponding values
58		*/
59	2	private function getPageData(ConfigInterface $config): array
60		{
61		$sort = [
62	2	'field' => $config->getRequest()->getSortBy(),
63	2	'type' => $config->getRequest()->getSortDir(),
64		];
65	2	$curPage = $config->getRequest()->getPageNum();
66
67	2	if ($curPage < 1) {
68		$curPage = 1;
69		}
70
71	2	$sortdata = $config->getSortColsDefault();
72	2	if (isset($sort['field'], $sort['type'])) {
73	2	if (in_array($sort['type'], array('asc', 'desc'), true) && in_array($sort['field'], $config->getSortCols(), true)) {
74	2	$sortdata = array($sort['field'] => $sort['type']);
75		}
76		}
77
78		return array(
79	2	'curpage' => $curPage,
80	2	'sortdata' => $sortdata,
81		);
82		}
83
84	1	private function getSimpleSearchBy(array $allowedCols, ?array $search): array
85		{
86	1	$searchBy = [];
87
88	1	if ($search === null) {
89		return $searchBy;
90		}
91
92	1	foreach ($search as $key => $val) {
93	1	if (in_array($key, $allowedCols, true) && $val !== null) {
94	1	$searchBy[$key] = array(
95	1	'type' => 'like',
96	1	'val' => $val,
97		);
98	1	if (strpos($key, 'GroupConcat') !== false) {
99	1	$searchBy[$key]['having'] = true;
100		}
101		}
102		}
103
104	1	return $searchBy;
105		}
106
107	1	private function getFullSearchBy(array $allowedCols, ?array $search): array
108		{
109	1	$searchBy = [];
110
111	1	foreach ($search as $data) {
112	1	if (!empty($data) && is_array($data) && isset($data['field']) && in_array($data['field'], $allowedCols, true)) {
113	1	$field = $data['field'];
114	1	unset($data['field']);
115	1	$searchBy[$field] = $data;
116	1	if (strpos($field, 'GroupConcat') !== false) {
117	1	$searchBy[$field]['having'] = true;
118		}
119		}
120		}
121
122	1	return $searchBy;
123		}
124
125		/**
126		* Get searchby data prepared for query builder
127		*
128		* If simple, $search must be set to:
129		* <code>
130		* $this->searchData = array(
131		* 'column_name1' => 'search_value1',
132		* 'column_name2' => 'search_value2',
133		* );
134		* </code>
135		* All comparisons will be treated as "like" here.
136		*
137		* If not simple, $search must be set to:
138		* <code>
139		* $this->searchData = array(
140		* array('field' => 'column_name1', 'type' => 'like', 'val' => 'search_value1'),
141		* array('field' => 'column_name2', 'type' => 'eq', 'val' => 'search_value2'),
142		* );
143		* </code>
144		*
145		* For both cases GroupConcat columns the result will receive extra $searchBy["column_name1"]["having"] = true
146		*
147		* @param array $allowedCols
148		* @param array\|null $search
149		* @param bool $simple
150		* @return array
151		*/
152	2	private function getSearchBy(array $allowedCols, ?array $search, bool $simple): array
153		{
154	2	return $simple ? $this->getSimpleSearchBy($allowedCols, $search) : $this->getFullSearchBy($allowedCols, $search);
155		}
156
157		/**
158		* Gets data for use in twig templates
159		*
160		* Consists of 8 steps:
161		*
162		* 1. Builds searchBy (see more: {@link QueryFilter::getSearchBy()}, {@link ConfigInterface::getAllowedCols()},
163		* {@link ConfigInterface::getSearchData()}, {@link ConfigInterface::isSimpleSearch()})
164		*
165		* 2. Modifies searchBy array with the shortcut expanders (see more: {@link ConfigInterface::getShortcutExpanders()})
166		*
167		* 3. Adds searchByExtra (if any) to the initial searchBy (see more: {@link ConfigInterface::getSearchByExtra()})
168		*
169		* 4. Obtains paging and sorting data (see more: {@link QueryFilter::getSortPageData()}, {@link ConfigInterface::getSortCols()},
170		* {@link ConfigInterface::getCurPage()}, {@link ConfigInterface::getSortBy()},
171		* {@link ConfigInterface::getSortColsDefault()})
172		*
173		* 5. Obtains data to according to the conditions defined in steps 1-4 (see more:
174		* {@link ConfigInterface::getRepositoryCallback()}, {@link ConfigInterface::getItemsPerPage})
175		*
176		* 6. Prepares and retuns the response
177		*
178		* @todo: refactor to smaller parts
179		*
180		* @return ResponseInterface
181		* @throws InvalidArgumentException
182		*/
183	2	public function getData(ConfigInterface $config): ResponseInterface
184		{
185		// 1. Get search by from query params limited by specified search by keys
186	2	$searchBy = $this->getSearchBy(
187	2	$config->getSearchAllowedCols(),
188	2	$config->getRequest()->getQuery(),
189	2	$config->getRequest()->isSimple()
190		);
191
192		// (optional) 2. replace search by shortcut(s) with more complicated expressions // **
193	2	$aliases = $config->getSearchByAliases();
194	2	foreach ($aliases as $alias => $value) {
195		if (!empty($searchBy[$alias])) {
196		if (!empty($value['data'])) {
197		$searchBy[$value['name']] = $value['data'];
198		$searchBy[$value['name']]['val'] = $searchBy[$alias]['val'];
199		} else {
200		$searchBy[$value['name']] = $searchBy[$alias];
201		}
202		unset($searchBy[$alias]);
203		}
204		}
205
206		// (optional) 3. Set search extra filters (can be used to display entries for one particular entity,
207		// or to add some extra conditions/filterings)
208	2	$searchByExtra = $config->getSearchByExtra();
209	2	if (!empty($searchByExtra)) {
210		if (is_object($searchByExtra) && ($searchByExtra instanceof \Closure)) {
		0 ignored issues – show introduced 2018-03-07 18:08 UTC by Report Bug Copy Issue Report The condition `is_object($searchByExtra...xtra instanceof Closure` can never be `true`. Loading history...
211		$searchByExtra = $searchByExtra($searchBy);
212		}
213		$searchBy = array_merge($searchBy, $searchByExtra);
214		}
215
216		// 4. Obtain paging and sorting data
217	2	$pageData = $this->getPageData($config);
218
219		// 4.5 Replace spaces by %
220	2	foreach ($searchBy as &$item) {
221	2	if (is_array($item) && isset($item['type'], $item['val']) && ($item['type'] === 'like') && preg_match('/[\s\.,]+/', $item['val'])) {
222	2	$words = preg_split('/[\s\.,]+/', $item['val']);
223	2	$item['val'] = $words ? implode('%', $words) : $item['val'];
224		}
225		}
226	2	unset($item);
227
228		// 5. Query database to obtain corresponding entities
229	2	$repositoryCallback = $config->getRepositoryCallback();
230	2	if (!\is_callable($repositoryCallback)) {
231		throw new InvalidArgumentException('Repository callback is not callable');
232		}
233	2	$itemsPerPage = $config->getRequest()->getLimit();
234	2	$args = (new QueryFilterArgs())
235	2	->setSearchBy($searchBy)
236	2	->setSortBy($pageData['sortdata'])
237	2	->setLimit($itemsPerPage)
238	2	->setOffset(($pageData['curpage'] - 1) * $itemsPerPage);
239
240		// $repositoryCallback can be an array, but since PHP 7.0 it's possible to use it as a function directly
241		// i.e. without using call_user_func[_array]().
242		// For the reference: https://trowski.com/2015/06/20/php-callable-paradox/
243	2	$startTime = microtime(true);
244	2	$filterData = $repositoryCallback($args);
245	2	$duration = microtime(true) - $startTime;
246	2	if (!$filterData instanceof QueryResult) {
247		throw new InvalidArgumentException('Repository callback must return an instance of QueryResult');
248		}
249
250		// 6. Prepare the data
251		/** @var ResponseInterface $response */
252	2	$response = new $this->responseClassName;
253	2	$response->setData($filterData->getResult());
254	2	$response->addMeta('total_records', $filterData->getTotalRows());
255	2	$response->addMeta('metrics', array(
256	2	'query_and_transformation' => $duration,
257		));
258
259		// 7. Return the data
260	2	return $response;
261		}
262		}
263

artprima / query-filter-bundle

Push — master ( 9af1c5...729744 )

QueryFilter::getFullSearchBy() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like