SQLQueryBuilder::run() - Code Metrics - Inspection of "scrutinizer-ci config changed for php 7.0" - soupmix/sql - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c4f500...65ebe1 )

by Mehmet

created 2017-02-09 10:42 UTC

SQLQueryBuilder::run() B

↳ Parent: SQLQueryBuilder

Complexity

Conditions	4
Paths	3

Size

Total Lines	22
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	22
ccs	0
cts	17
cp	0
rs	8.9197
cc	4
eloc	17
nc	3
nop	0
crap	20

<?php

namespace Soupmix;

class SQLQueryBuilder extends AbstractQueryBuilder
{

    private $queryBuilder;

    public function run()
    {
        $this->queryBuilder = $this->getQueryBuilder();
        $this->setJoins();
        $count = $this->getCount();
        if (!isset($count[0]['total']) || ($count[0]['total']===0)) {
            return ['total' => 0, 'data' => null];
        }
        $numberOfRows = $count[0]['total'];
        $this->setSortOrders();
        $this->setOffsetAndLimit();
        $this->setReturnFields();
        $stmt = $this->conn->executeQuery(
            $this->queryBuilder->getSql(),
            $this->queryBuilder->getParameters()
        );
        $result = $stmt->fetchAll(\PDO::FETCH_ASSOC);
        if ($this->distinctFieldName !== null) {
                $numberOfRows = count($result);
        }
        return ['total' => $numberOfRows, 'data' => $result];
    }

    private function getQueryBuilder()
    {
        if ($this->orFilters !== null) {
            $this->andFilters[] = $this->orFilters;
        }
        $this->filters      = $this->andFilters;
        return $this->buildQuery($this->collection, $this->filters);
    }

    private function getCount()
    {
        $queryBuilderCount = clone $this->queryBuilder;
        $queryBuilderCount->select(' COUNT(*) AS total ');
        $stmt = $this->conn->executeQuery($queryBuilderCount->getSql(), $queryBuilderCount->getParameters());
        return $stmt->fetchAll(\PDO::FETCH_ASSOC);
    }

    private function setSortOrders()
    {
        if ($this->sortFields !== null) {
            foreach ($this->addAlias($this->sortFields) as $sortKey => $sortDir) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                $this->queryBuilder->addOrderBy($sortKey, $sortDir);
            }
        }
    }

    private function setJoins()
    {
        $this->setJoinsForType('innerJoin');
        $this->setJoinsForType('leftJoin');
        $this->setJoinsForType('rightJoin');
        $this->setJoinsForType('outerJoin');
    }

    private function setJoinsForType($joinType)
    {
        if ($this->{$joinType} === null) {
            return;
        }
        foreach ($this->{$joinType} as $collectionName => $collection) {
            $fieldNames = $this->addAlias($collection['returnFields'], $collectionName);
            $this->returnFieldsForJoin($fieldNames);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            $joinCondition = '';
            foreach ($collection['relations'] as $relation) {
                $joinCondition .= empty($joinCondition) ? '':' AND ';
                $relationType = array_keys($relation)[0];
                $source = array_keys($relation[$relationType])[0];
                $condition = $collectionName . '.' . $source
                    . ' = ' . $this->collection . '.' . $relation[$relationType][$source];
                if ($relationType != 'field') {
                    $condition = $collectionName . '.' . $source . ' '
                        . $relationType . ' '. $relation[$relationType][$source];
                }
                $joinCondition .= $condition;
            }
            $this->queryBuilder->{$joinType}($this->collection, $collectionName, $collectionName, $joinCondition);
        }
        return $this;
    }
    public function returnFieldsForJoin(array $fieldNames = null)
    {
        if ($fieldNames !== null) {
            foreach ($fieldNames as $fieldName) {
                $this->fieldNames[] = $fieldName;
            }
        }
    }

    private function setReturnFields()
    {
        if ($this->distinctFieldName === null) {
            $fieldNames = ($this->fieldNames === null)
                ? $this->addAlias('*')
                : $this->addAlias($this->fieldNames);
            $this->queryBuilder->select($fieldNames);
            return;
        }
        $this->queryBuilder->select('DISTINCT (`' . $this->collection . '`.`' . $this->distinctFieldName . '`)');
    }

    private function setOffsetAndLimit()
    {
        $this->queryBuilder->setFirstResult($this->offset)
            ->setMaxResults($this->limit);
    }

    private function addAlias($fields, $collection = null)
    {
        $collection = (!is_null($collection)) ? $collection : $this->collection;
        if (!is_array($fields)) {
            return  $collection . '.' . $fields;
        }
        if (!is_array($fields)) {
            return  $collection . '.' . $fields;
        }
        $newFields = [];
        foreach ($fields as $field => $value) {
            if (strpos($value, '.')!== false) {
                $newFields[] = $value;
                continue;
            }
            if (is_int($field)) {
                if (!is_array($fields)) {
                    $newFields[] = $collection . '.' . $fields;
                    continue;
                }
                $newFields[] = $collection . '.' . $value;
                continue;
            }
            $newFields[$collection.'.'.$field] = $value;
        }
        return $newFields;
    }

    protected function buildQuery($collection, $filters)
    {
        $queryBuilder = $this->conn->createQueryBuilder();
        $queryBuilder->from($collection, $collection);
        if ($filters === null) {
            return $queryBuilder;
        }
        return $this->buildQueryFilters($queryBuilder, $filters);
    }

    protected function buildQueryFilters($queryBuilder, $filters)
    {
        foreach ($filters as $key => $value) {
            if (is_array($value) && strpos($key, '__') === false) {
                $queryBuilder = $this->buildQueryForOr($queryBuilder, $value);
                continue;
            }
            $queryBuilder = $this->buildQueryForAnd($queryBuilder, $key, $value);
        }
        return $queryBuilder;
    }

    protected function buildQueryForAnd($queryBuilder, $key, $value)
    {
        $sqlOptions = self::buildFilter([$key => $value]);
        if (in_array($sqlOptions['method'], ['in', 'notIn'], true)) {

            $queryBuilder->andWhere(
                $queryBuilder->expr()->{$sqlOptions['method']}(
                    $this->collection . '.' . $sqlOptions['key'], $sqlOptions['value']
                )
            );
            return $queryBuilder;
        }
        $queryBuilder->andWhere(
            '`' . $this->collection . '`.`' . $sqlOptions['key'].'`'
            . ' ' . $sqlOptions['operand']
            . ' ' . $queryBuilder->createNamedParameter($sqlOptions['value'])
        );
        return $queryBuilder;
    }
    protected function buildQueryForOr($queryBuilder, $value)
    {
        $orQuery =[];
        foreach ($value as $orValue) {
            $subKey = array_keys($orValue)[0];
            $subValue = $orValue[$subKey];
            $sqlOptions = self::buildFilter([$subKey => $subValue]);
            if (in_array($sqlOptions['method'], ['in', 'notIn'], true)) {

                $orQuery[] =  $queryBuilder->expr()->{$sqlOptions['method']}(
                    $this->collection . '.' . $sqlOptions['key'], $sqlOptions['value']
                );
                continue;
            }
            $orQuery[] =
                '`' . $this->collection . '`.`' . $sqlOptions['key'].'`'
                . ' ' . $sqlOptions['operand']
                . ' ' . $queryBuilder->createNamedParameter($sqlOptions['value']);
        }
        $queryBuilder->andWhere(
            '(' . implode(' OR ', $orQuery) . ')'
        );
        return $queryBuilder;
    }


    public static function buildFilter($filter)
    {
        $key = array_keys($filter)[0];
        $value = $filter[$key];
        $operator = ' = ';
        $method = 'eq';
        $options =[
            'gte'       => ['method' => 'gte', 'operand' => ' >= '],
            'gt'        => ['method' => 'gt', 'operand' => ' > '],
            'lte'       => ['method' => 'lte', 'operand' => ' <= '],
            'lt'        => ['method' => 'lt', 'operand' => ' < '],
            'in'        => ['method' => 'in', 'operand' => ' IN '],
            '!in'       => ['method' => 'notIn', 'operand' => ' NOT IN '],
            'not'       => ['method' => 'not', 'operand' => ' != '],
            'wildcard'  => ['method' => 'like', 'operand' => ' LIKE '],
            'prefix'    => ['method' => 'like', 'operand' => ' LIKE '],
        ];
        if (strpos($key, '__') !== false) {
            preg_match('/__(.*?)$/', $key, $matches);
            $key        = str_replace($matches[0], '', $key);
            $queryOperator   = $matches[1];
            $method     = $options[$queryOperator]['method'];
            $operator   = $options[$queryOperator]['operand'];
            switch ($queryOperator) {
                case 'wildcard':
                    $value = '%'.str_replace(array('?', '*'), array('_', '%'), $value).'%';
                    break;
                case 'prefix':
                    $value .= '%';
                    break;
            }
        }
        return [
            'key'       => $key,
            'operand'   => $operator,
            'method'    => $method,
            'value'     => $value
        ];
    }
}


1		<?php
2
3		namespace Soupmix;
4
5		class SQLQueryBuilder extends AbstractQueryBuilder
6		{
7
8		private $queryBuilder;
9
10		public function run()
11		{
12		$this->queryBuilder = $this->getQueryBuilder();
13		$this->setJoins();
14		$count = $this->getCount();
15		if (!isset($count[0]['total']) \|\| ($count[0]['total']===0)) {
16		return ['total' => 0, 'data' => null];
17		}
18		$numberOfRows = $count[0]['total'];
19		$this->setSortOrders();
20		$this->setOffsetAndLimit();
21		$this->setReturnFields();
22		$stmt = $this->conn->executeQuery(
23		$this->queryBuilder->getSql(),
24		$this->queryBuilder->getParameters()
25		);
26		$result = $stmt->fetchAll(\PDO::FETCH_ASSOC);
27		if ($this->distinctFieldName !== null) {
28		$numberOfRows = count($result);
29		}
30		return ['total' => $numberOfRows, 'data' => $result];
31		}
32
33		private function getQueryBuilder()
34		{
35		if ($this->orFilters !== null) {
36		$this->andFilters[] = $this->orFilters;
37		}
38		$this->filters = $this->andFilters;
39		return $this->buildQuery($this->collection, $this->filters);
40		}
41
42		private function getCount()
43		{
44		$queryBuilderCount = clone $this->queryBuilder;
45		$queryBuilderCount->select(' COUNT(*) AS total ');
46		$stmt = $this->conn->executeQuery($queryBuilderCount->getSql(), $queryBuilderCount->getParameters());
47		return $stmt->fetchAll(\PDO::FETCH_ASSOC);
48		}
49
50		private function setSortOrders()
51		{
52		if ($this->sortFields !== null) {
53		foreach ($this->addAlias($this->sortFields) as $sortKey => $sortDir) {
		0 ignored issues – show Bug introduced 2016-07-13 14:23 UTC by Report Bug Copy Issue Report The expression `$this->addAlias($this->sortFields)` of type `string\|array` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
54		$this->queryBuilder->addOrderBy($sortKey, $sortDir);
55		}
56		}
57		}
58
59		private function setJoins()
60		{
61		$this->setJoinsForType('innerJoin');
62		$this->setJoinsForType('leftJoin');
63		$this->setJoinsForType('rightJoin');
64		$this->setJoinsForType('outerJoin');
65		}
66
67		private function setJoinsForType($joinType)
68		{
69		if ($this->{$joinType} === null) {
70		return;
71		}
72		foreach ($this->{$joinType} as $collectionName => $collection) {
73		$fieldNames = $this->addAlias($collection['returnFields'], $collectionName);
74		$this->returnFieldsForJoin($fieldNames);
		0 ignored issues – show Bug introduced 2016-07-13 14:23 UTC by Report Bug Copy Issue Report It seems like `$fieldNames` defined by `$this->addAlias($collect...lds'], $collectionName)` on line `73` can also be of type `string`; however, `Soupmix\SQLQueryBuilder::returnFieldsForJoin()` does only seem to accept `null\|array`, 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...
75		$joinCondition = '';
76		foreach ($collection['relations'] as $relation) {
77		$joinCondition .= empty($joinCondition) ? '':' AND ';
78		$relationType = array_keys($relation)[0];
79		$source = array_keys($relation[$relationType])[0];
80		$condition = $collectionName . '.' . $source
81		. ' = ' . $this->collection . '.' . $relation[$relationType][$source];
82		if ($relationType != 'field') {
83		$condition = $collectionName . '.' . $source . ' '
84		. $relationType . ' '. $relation[$relationType][$source];
85		}
86		$joinCondition .= $condition;
87		}
88		$this->queryBuilder->{$joinType}($this->collection, $collectionName, $collectionName, $joinCondition);
89		}
90		return $this;
91		}
92		public function returnFieldsForJoin(array $fieldNames = null)
93		{
94		if ($fieldNames !== null) {
95		foreach ($fieldNames as $fieldName) {
96		$this->fieldNames[] = $fieldName;
97		}
98		}
99		}
100
101		private function setReturnFields()
102		{
103		if ($this->distinctFieldName === null) {
104		$fieldNames = ($this->fieldNames === null)
105		? $this->addAlias('*')
106		: $this->addAlias($this->fieldNames);
107		$this->queryBuilder->select($fieldNames);
108		return;
109		}
110		$this->queryBuilder->select('DISTINCT (`' . $this->collection . '`.`' . $this->distinctFieldName . '`)');
111		}
112
113		private function setOffsetAndLimit()
114		{
115		$this->queryBuilder->setFirstResult($this->offset)
116		->setMaxResults($this->limit);
117		}
118
119		private function addAlias($fields, $collection = null)
120		{
121		$collection = (!is_null($collection)) ? $collection : $this->collection;
122		if (!is_array($fields)) {
123		return $collection . '.' . $fields;
124		}
125		if (!is_array($fields)) {
126		return $collection . '.' . $fields;
127		}
128		$newFields = [];
129		foreach ($fields as $field => $value) {
130		if (strpos($value, '.')!== false) {
131		$newFields[] = $value;
132		continue;
133		}
134		if (is_int($field)) {
135		if (!is_array($fields)) {
136		$newFields[] = $collection . '.' . $fields;
137		continue;
138		}
139		$newFields[] = $collection . '.' . $value;
140		continue;
141		}
142		$newFields[$collection.'.'.$field] = $value;
143		}
144		return $newFields;
145		}
146
147		protected function buildQuery($collection, $filters)
148		{
149		$queryBuilder = $this->conn->createQueryBuilder();
150		$queryBuilder->from($collection, $collection);
151		if ($filters === null) {
152		return $queryBuilder;
153		}
154		return $this->buildQueryFilters($queryBuilder, $filters);
155		}
156
157		protected function buildQueryFilters($queryBuilder, $filters)
158		{
159		foreach ($filters as $key => $value) {
160		if (is_array($value) && strpos($key, '__') === false) {
161		$queryBuilder = $this->buildQueryForOr($queryBuilder, $value);
162		continue;
163		}
164		$queryBuilder = $this->buildQueryForAnd($queryBuilder, $key, $value);
165		}
166		return $queryBuilder;
167		}
168
169		protected function buildQueryForAnd($queryBuilder, $key, $value)
170		{
171		$sqlOptions = self::buildFilter([$key => $value]);
172	View Code Duplication	if (in_array($sqlOptions['method'], ['in', 'notIn'], true)) {
		0 ignored issues – show Duplication introduced 2016-06-27 07:38 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
173		$queryBuilder->andWhere(
174		$queryBuilder->expr()->{$sqlOptions['method']}(
175		$this->collection . '.' . $sqlOptions['key'], $sqlOptions['value']
176		)
177		);
178		return $queryBuilder;
179		}
180		$queryBuilder->andWhere(
181		'`' . $this->collection . '`.`' . $sqlOptions['key'].'`'
182		. ' ' . $sqlOptions['operand']
183		. ' ' . $queryBuilder->createNamedParameter($sqlOptions['value'])
184		);
185		return $queryBuilder;
186		}
187		protected function buildQueryForOr($queryBuilder, $value)
188		{
189		$orQuery =[];
190		foreach ($value as $orValue) {
191		$subKey = array_keys($orValue)[0];
192		$subValue = $orValue[$subKey];
193		$sqlOptions = self::buildFilter([$subKey => $subValue]);
194	View Code Duplication	if (in_array($sqlOptions['method'], ['in', 'notIn'], true)) {
		0 ignored issues – show Duplication introduced 2016-06-27 07:38 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
195		$orQuery[] = $queryBuilder->expr()->{$sqlOptions['method']}(
196		$this->collection . '.' . $sqlOptions['key'], $sqlOptions['value']
197		);
198		continue;
199		}
200		$orQuery[] =
201		'`' . $this->collection . '`.`' . $sqlOptions['key'].'`'
202		. ' ' . $sqlOptions['operand']
203		. ' ' . $queryBuilder->createNamedParameter($sqlOptions['value']);
204		}
205		$queryBuilder->andWhere(
206		'(' . implode(' OR ', $orQuery) . ')'
207		);
208		return $queryBuilder;
209		}
210
211
212		public static function buildFilter($filter)
213		{
214		$key = array_keys($filter)[0];
215		$value = $filter[$key];
216		$operator = ' = ';
217		$method = 'eq';
218		$options =[
219		'gte' => ['method' => 'gte', 'operand' => ' >= '],
220		'gt' => ['method' => 'gt', 'operand' => ' > '],
221		'lte' => ['method' => 'lte', 'operand' => ' <= '],
222		'lt' => ['method' => 'lt', 'operand' => ' < '],
223		'in' => ['method' => 'in', 'operand' => ' IN '],
224		'!in' => ['method' => 'notIn', 'operand' => ' NOT IN '],
225		'not' => ['method' => 'not', 'operand' => ' != '],
226		'wildcard' => ['method' => 'like', 'operand' => ' LIKE '],
227		'prefix' => ['method' => 'like', 'operand' => ' LIKE '],
228		];
229		if (strpos($key, '__') !== false) {
230		preg_match('/__(.*?)$/', $key, $matches);
231		$key = str_replace($matches[0], '', $key);
232		$queryOperator = $matches[1];
233		$method = $options[$queryOperator]['method'];
234		$operator = $options[$queryOperator]['operand'];
235		switch ($queryOperator) {
236		case 'wildcard':
237		$value = '%'.str_replace(array('?', '*'), array('_', '%'), $value).'%';
238		break;
239		case 'prefix':
240		$value .= '%';
241		break;
242		}
243		}
244		return [
245		'key' => $key,
246		'operand' => $operator,
247		'method' => $method,
248		'value' => $value
249		];
250		}
251		}
252

soupmix / sql

Push — master ( c4f500...65ebe1 )

SQLQueryBuilder::run() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like