Builder::getFilteredQuery() - Code Metrics - vaibhavpandeyvpz/doctrine-datatables - Measure and Improve Code Quality continuously with Scrutinizer

Builder::getFilteredQuery() F
last analyzed 2019-01-25 12:34 UTC

↳ Parent: Builder

Complexity

Conditions	20
Paths	396

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	73
rs	0.8833
c	0
b	0
f	0
cc	20
nc	396
nop	0

How to fix Long Method Complexity

<?php

/*
 * This file is part of vaibhavpandeyvpz/doctrine-datatables package.
 *
 * (c) Vaibhav Pandey <[email protected]>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.md.
 */

namespace Doctrine\DataTables;

use Doctrine\DBAL\Query\QueryBuilder;
use Doctrine\ORM\QueryBuilder as ORMQueryBuilder;
use Doctrine\ORM\Tools\Pagination\Paginator;

/**
 * Class Builder
 * @package Doctrine\DataTables
 */
class Builder
{
    /**
     * @var array
     */
    protected $columnAliases = array();

    /**
     * @var string
     */
    protected $columnField = 'data'; // or 'name'

    /**
     * @var string
     */
    protected $indexColumn = '*';

    /**
     * @var bool
     */
    protected $returnCollection = false;

    /**
     * @var bool
     */
    protected $caseInsensitive = false;

    /**
     * @var QueryBuilder|ORMQueryBuilder
     */
    protected $queryBuilder;

    /**
     * @var array
     */
    protected $requestParams;

    /**
     * @return array
     */
    public function getData()
    {
        $query = $this->getFilteredQuery();
        $columns = &$this->requestParams['columns'];
        // Order
        if (array_key_exists('order', $this->requestParams)) {
            $order = &$this->requestParams['order'];
            foreach ($order as $sort) {
                $column = &$columns[intval($sort['column'])];
                if (array_key_exists($column[$this->columnField], $this->columnAliases)) {
                    $column[$this->columnField] = $this->columnAliases[$column[$this->columnField]];
                }
                $query->addOrderBy($column[$this->columnField], $sort['dir']);
            }
        }
        // Offset
        if (array_key_exists('start', $this->requestParams)) {
            $query->setFirstResult(intval($this->requestParams['start']));
        }
        // Limit
        if (array_key_exists('length', $this->requestParams)) {
            $length = intval($this->requestParams['length']);
            if ($length > 0) {
                $query->setMaxResults($length);
            }
        }
        // Fetch
        if ($query instanceof ORMQueryBuilder) {
            if ($this->returnCollection)
                return $query->getQuery()->getResult();
            else
                return $query->getQuery()->getScalarResult();
        } else {
            return $query->execute()->fetchAll();
        }
    }

    /**
     * @return QueryBuilder|ORMQueryBuilder
     */
    public function getFilteredQuery()
    {
        $query = clone $this->queryBuilder;
        $columns = &$this->requestParams['columns'];
        $c = count($columns);
        // Search
        if (array_key_exists('search', $this->requestParams)) {
            if ($value = trim($this->requestParams['search']['value'])) {
                $orX = $query->expr()->orX();
                for ($i = 0; $i < $c; $i++) {
                    $column = &$columns[$i];
                    if ($column['searchable'] == 'true') {
                        if (array_key_exists($column[$this->columnField], $this->columnAliases)) {
                            $column[$this->columnField] = $this->columnAliases[$column[$this->columnField]];
                        }
                        if ($this->caseInsensitive) {
                            $searchColumn = "lower(" . $column[$this->columnField] . ")";
                            $orX->add($query->expr()->like($searchColumn, 'lower(:search)'));
                        } else {
                            $orX->add($query->expr()->like($column[$this->columnField], ':search'));
                        }
                    }
                }
                if ($orX->count() >= 1) {
                    $query->andWhere($orX)
                        ->setParameter('search', "%{$value}%");
                }
            }
        }
        // Filter
        for ($i = 0; $i < $c; $i++) {
            $column = &$columns[$i];
            $andX = $query->expr()->andX();
            if (($column['searchable'] == 'true') && ($value = trim($column['search']['value']))) {
                if (array_key_exists($column[$this->columnField], $this->columnAliases)) {
                    $column[$this->columnField] = $this->columnAliases[$column[$this->columnField]];
                }
                $operator = preg_match('~^\[(?<operator>[=!%<>]+)\].*$~', $value, $matches) ? $matches['operator'] : '=';
                if ($this->caseInsensitive) {
                    $searchColumn = "lower(" . $column[$this->columnField] . ")";
                    $filter = "lower(:filter_{$i})";
                } else {
                    $searchColumn = $column[$this->columnField];
                    $filter = ":filter_{$i}";
                }
                switch ($operator) {
                    case '!=': // Not equals; usage: [!=]search_term
                        $andX->add($query->expr()->neq($searchColumn, $filter));
                        break;
                    case '%': // Like; usage: [%]search_term
                        $andX->add($query->expr()->like($searchColumn, $filter));
                        $value = "%{$value}%";
                        break;
                    case '<': // Less than; usage: [>]search_term
                        $andX->add($query->expr()->lt($searchColumn, $filter));
                        break;
                    case '>': // Greater than; usage: [<]search_term
                        $andX->add($query->expr()->gt($searchColumn, $filter));
                        break;
                    case '=': // Equals (default); usage: [=]search_term
                    default:
                        $andX->add($query->expr()->eq($searchColumn, $filter));
                        break;
                }
                $query->setParameter("filter_{$i}", $value);
            }
            if ($andX->count() >= 1) {
                $query->andWhere($andX);
            }
        }
        // Done
        return $query;
    }

    /**
     * @return int
     */
    public function getRecordsFiltered()
    {
        $query = $this->getFilteredQuery();
        $paginator = new Paginator($query, $fetchJoinCollection = true);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        return $paginator->count();
    }

    /**
     * @return int
     */
    public function getRecordsTotal()
    {
        $query = clone $this->queryBuilder;
        $paginator = new Paginator($query, $fetchJoinCollection = true);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        return $paginator->count();
    }

    /**
     * @return array
     */
    public function getResponse()
    {
        return array(
            'data' => $this->getData(),
            'draw' => $this->requestParams['draw'],
            'recordsFiltered' => $this->getRecordsFiltered(),
            'recordsTotal' => $this->getRecordsTotal(),
        );
    }

    /**
     * @param string $indexColumn
     * @return static
     */
    public function withIndexColumn($indexColumn)
    {
        $this->indexColumn = $indexColumn;
        return $this;
    }

    /**
     * @param array $columnAliases
     * @return static
     */
    public function withColumnAliases($columnAliases)
    {
        $this->columnAliases = $columnAliases;
        return $this;
    }

    /**
     * @param bool $returnObjectCollection
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return static
     */
    public function withReturnCollection($returnCollection)
    {
        $this->returnCollection = $returnCollection;
        return $this;
    }

    /**
     * @param bool $caseInsensitive
     * @return static
     */
    public function withCaseInsensitive($caseInsensitive)
    {
        $this->caseInsensitive = $caseInsensitive;
        return $this;
    }

    /**
     * @param string $columnField
     * @return static
     */
    public function withColumnField($columnField)
    {
        $this->columnField = $columnField;
        return $this;
    }

    /**
     * @param QueryBuilder|ORMQueryBuilder $queryBuilder
     * @return static
     */
    public function withQueryBuilder($queryBuilder)
    {
        $this->queryBuilder = $queryBuilder;
        return $this;
    }

    /**
     * @param array $requestParams
     * @return static
     */
    public function withRequestParams($requestParams)
    {
        $this->requestParams = $requestParams;
        return $this;
    }
}


1			<?php
2
3			/*
4			* This file is part of vaibhavpandeyvpz/doctrine-datatables package.
5			*
6			* (c) Vaibhav Pandey <[email protected]>
7			*
8			* This source file is subject to the MIT license that is bundled
9			* with this source code in the file LICENSE.md.
10			*/
11
12			namespace Doctrine\DataTables;
13
14			use Doctrine\DBAL\Query\QueryBuilder;
15			use Doctrine\ORM\QueryBuilder as ORMQueryBuilder;
16			use Doctrine\ORM\Tools\Pagination\Paginator;
17
18			/**
19			* Class Builder
20			* @package Doctrine\DataTables
21			*/
22			class Builder
23			{
24			/**
25			* @var array
26			*/
27			protected $columnAliases = array();
28
29			/**
30			* @var string
31			*/
32			protected $columnField = 'data'; // or 'name'
33
34			/**
35			* @var string
36			*/
37			protected $indexColumn = '*';
38
39			/**
40			* @var bool
41			*/
42			protected $returnCollection = false;
43
44			/**
45			* @var bool
46			*/
47			protected $caseInsensitive = false;
48
49			/**
50			* @var QueryBuilder\|ORMQueryBuilder
51			*/
52			protected $queryBuilder;
53
54			/**
55			* @var array
56			*/
57			protected $requestParams;
58
59			/**
60			* @return array
61			*/
62			public function getData()
63			{
64			$query = $this->getFilteredQuery();
65			$columns = &$this->requestParams['columns'];
66			// Order
67			if (array_key_exists('order', $this->requestParams)) {
68			$order = &$this->requestParams['order'];
69			foreach ($order as $sort) {
70			$column = &$columns[intval($sort['column'])];
71			if (array_key_exists($column[$this->columnField], $this->columnAliases)) {
72			$column[$this->columnField] = $this->columnAliases[$column[$this->columnField]];
73			}
74			$query->addOrderBy($column[$this->columnField], $sort['dir']);
75			}
76			}
77			// Offset
78			if (array_key_exists('start', $this->requestParams)) {
79			$query->setFirstResult(intval($this->requestParams['start']));
80			}
81			// Limit
82			if (array_key_exists('length', $this->requestParams)) {
83			$length = intval($this->requestParams['length']);
84			if ($length > 0) {
85			$query->setMaxResults($length);
86			}
87			}
88			// Fetch
89			if ($query instanceof ORMQueryBuilder) {
90			if ($this->returnCollection)
91			return $query->getQuery()->getResult();
92			else
93			return $query->getQuery()->getScalarResult();
94			} else {
95			return $query->execute()->fetchAll();
96			}
97			}
98
99			/**
100			* @return QueryBuilder\|ORMQueryBuilder
101			*/
102			public function getFilteredQuery()
103			{
104			$query = clone $this->queryBuilder;
105			$columns = &$this->requestParams['columns'];
106			$c = count($columns);
107			// Search
108			if (array_key_exists('search', $this->requestParams)) {
109			if ($value = trim($this->requestParams['search']['value'])) {
110			$orX = $query->expr()->orX();
111			for ($i = 0; $i < $c; $i++) {
112			$column = &$columns[$i];
113			if ($column['searchable'] == 'true') {
114			if (array_key_exists($column[$this->columnField], $this->columnAliases)) {
115			$column[$this->columnField] = $this->columnAliases[$column[$this->columnField]];
116			}
117			if ($this->caseInsensitive) {
118			$searchColumn = "lower(" . $column[$this->columnField] . ")";
119			$orX->add($query->expr()->like($searchColumn, 'lower(:search)'));
120			} else {
121			$orX->add($query->expr()->like($column[$this->columnField], ':search'));
122			}
123			}
124			}
125			if ($orX->count() >= 1) {
126			$query->andWhere($orX)
127			->setParameter('search', "%{$value}%");
128			}
129			}
130			}
131			// Filter
132			for ($i = 0; $i < $c; $i++) {
133			$column = &$columns[$i];
134			$andX = $query->expr()->andX();
135			if (($column['searchable'] == 'true') && ($value = trim($column['search']['value']))) {
136			if (array_key_exists($column[$this->columnField], $this->columnAliases)) {
137			$column[$this->columnField] = $this->columnAliases[$column[$this->columnField]];
138			}
139			$operator = preg_match('~^\[(?<operator>[=!%<>]+)\].*$~', $value, $matches) ? $matches['operator'] : '=';
140			if ($this->caseInsensitive) {
141			$searchColumn = "lower(" . $column[$this->columnField] . ")";
142			$filter = "lower(:filter_{$i})";
143			} else {
144			$searchColumn = $column[$this->columnField];
145			$filter = ":filter_{$i}";
146			}
147			switch ($operator) {
148			case '!=': // Not equals; usage: [!=]search_term
149			$andX->add($query->expr()->neq($searchColumn, $filter));
150			break;
151			case '%': // Like; usage: [%]search_term
152			$andX->add($query->expr()->like($searchColumn, $filter));
153			$value = "%{$value}%";
154			break;
155			case '<': // Less than; usage: [>]search_term
156			$andX->add($query->expr()->lt($searchColumn, $filter));
157			break;
158			case '>': // Greater than; usage: [<]search_term
159			$andX->add($query->expr()->gt($searchColumn, $filter));
160			break;
161			case '=': // Equals (default); usage: [=]search_term
162			default:
163			$andX->add($query->expr()->eq($searchColumn, $filter));
164			break;
165			}
166			$query->setParameter("filter_{$i}", $value);
167			}
168			if ($andX->count() >= 1) {
169			$query->andWhere($andX);
170			}
171			}
172			// Done
173			return $query;
174			}
175
176			/**
177			* @return int
178			*/
179			public function getRecordsFiltered()
180			{
181			$query = $this->getFilteredQuery();
182			$paginator = new Paginator($query, $fetchJoinCollection = true);
			0 ignored issues – show Bug introduced 2019-01-25 12:34 UTC by Report Bug Copy Issue Report It seems like `$query` defined by `$this->getFilteredQuery()` on line `181` can also be of type `object<Doctrine\DBAL\Query\QueryBuilder>`; however, `Doctrine\ORM\Tools\Pagin...aginator::__construct()` does only seem to accept `object<Doctrine\ORM\Quer...trine\ORM\QueryBuilder>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
183			return $paginator->count();
184			}
185
186			/**
187			* @return int
188			*/
189			public function getRecordsTotal()
190			{
191			$query = clone $this->queryBuilder;
192			$paginator = new Paginator($query, $fetchJoinCollection = true);
			0 ignored issues – show Bug introduced 2019-01-25 12:34 UTC by Report Bug Copy Issue Report It seems like `$query` defined by `clone $this->queryBuilder` on line `191` can also be of type `object<Doctrine\DBAL\Query\QueryBuilder>`; however, `Doctrine\ORM\Tools\Pagin...aginator::__construct()` does only seem to accept `object<Doctrine\ORM\Quer...trine\ORM\QueryBuilder>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
193			return $paginator->count();
194			}
195
196			/**
197			* @return array
198			*/
199			public function getResponse()
200			{
201			return array(
202			'data' => $this->getData(),
203			'draw' => $this->requestParams['draw'],
204			'recordsFiltered' => $this->getRecordsFiltered(),
205			'recordsTotal' => $this->getRecordsTotal(),
206			);
207			}
208
209			/**
210			* @param string $indexColumn
211			* @return static
212			*/
213			public function withIndexColumn($indexColumn)
214			{
215			$this->indexColumn = $indexColumn;
216			return $this;
217			}
218
219			/**
220			* @param array $columnAliases
221			* @return static
222			*/
223			public function withColumnAliases($columnAliases)
224			{
225			$this->columnAliases = $columnAliases;
226			return $this;
227			}
228
229			/**
230			* @param bool $returnObjectCollection
			0 ignored issues – show Bug introduced 2017-08-17 14:31 UTC by Report Bug Copy Issue Report There is no parameter named `$returnObjectCollection`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
231			* @return static
232			*/
233			public function withReturnCollection($returnCollection)
234			{
235			$this->returnCollection = $returnCollection;
236			return $this;
237			}
238
239			/**
240			* @param bool $caseInsensitive
241			* @return static
242			*/
243			public function withCaseInsensitive($caseInsensitive)
244			{
245			$this->caseInsensitive = $caseInsensitive;
246			return $this;
247			}
248
249			/**
250			* @param string $columnField
251			* @return static
252			*/
253			public function withColumnField($columnField)
254			{
255			$this->columnField = $columnField;
256			return $this;
257			}
258
259			/**
260			* @param QueryBuilder\|ORMQueryBuilder $queryBuilder
261			* @return static
262			*/
263			public function withQueryBuilder($queryBuilder)
264			{
265			$this->queryBuilder = $queryBuilder;
266			return $this;
267			}
268
269			/**
270			* @param array $requestParams
271			* @return static
272			*/
273			public function withRequestParams($requestParams)
274			{
275			$this->requestParams = $requestParams;
276			return $this;
277			}
278			}
279

vaibhavpandeyvpz / doctrine-datatables

GitHub Access Token became invalid

Builder::getFilteredQuery() F last analyzed 2019-01-25 12:34 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

Builder::getFilteredQuery() F
last analyzed 2019-01-25 12:34 UTC