Select::addSelect() - Code Metrics - Inspection of "Merge pull request #474 from bluzphp/develop" - bluzphp/framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e47c19...3aaaf2 )

by Anton

created 2021-07-05 13:03 UTC

Select::addSelect() A

↳ Parent: Select

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php

/**
 * Bluz Framework Component
 *
 * @copyright Bluz PHP Team
 * @link      https://github.com/bluzphp/framework
 */

declare(strict_types=1);

namespace Bluz\Db\Query;

use Bluz\Db\Exception\DbException;
use Bluz\Proxy\Db;

/**
 * Builder of SELECT queries
 *
 * @package Bluz\Db\Query
 */
class Select extends AbstractBuilder
{
    use Traits\From;
    use Traits\Where;
    use Traits\Order;
    use Traits\Limit;

    /**
     * <code>
     * [
     *     'u.id', 'u.name',
     *     'p.id', 'p.title'
     * ]
     * </code>
     *
     * @var array[]
     */
    protected $select = [];
    protected $groupBy = [];
    protected $having = null;

    /**
     * @var mixed PDO fetch types or object class
     */
    protected $fetchType = \PDO::FETCH_ASSOC;

    /**
     * {@inheritdoc}
     *
     * @param  integer|string|object $fetchType
     *
     * @return integer|string|array
     */
    public function execute($fetchType = null)
    {
        if (!$fetchType) {
            $fetchType = $this->fetchType;
        }

        switch ($fetchType) {
            case (!is_int($fetchType)):
                return Db::fetchObjects($this->getSql(), $this->params, $fetchType);
            case \PDO::FETCH_CLASS:
                return Db::fetchObjects($this->getSql(), $this->params);
            case \PDO::FETCH_ASSOC:
            default:
                return Db::fetchAll($this->getSql(), $this->params);
        }
    }

    /**
     * Setup fetch type, any of PDO, or any Class
     *
     * @param  string $fetchType
     *
     * @return Select instance
     */
    public function setFetchType($fetchType): Select
    {
        $this->fetchType = $fetchType;
        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getSql(): string
    {
        return $this->prepareSelect()
            . $this->prepareFrom()
            . $this->prepareWhere()
            . $this->prepareGroupBy()
            . $this->prepareHaving()
            . $this->prepareOrderBy()
            . $this->prepareLimit();
    }

    /**
     * Specifies an item that is to be returned in the query result
     * Replaces any previously specified selections, if any
     *
     * Example
     * <code>
     *     $sb = new Select();
     *     $sb
     *         ->select('u.id', 'p.id')
     *         ->from('users', 'u')
     *         ->leftJoin('u', 'phone', 'p', 'u.id = p.user_id');
     * </code>
     *
     * @param  string[] $select the selection expressions
     *
     * @return Select instance
     */
    public function select(...$select): Select
    {
        $this->select = $select;

        return $this;
    }

    /**
     * Adds an item that is to be returned in the query result.
     *
     * Example
     * <code>
     *     $sb = new Select();
     *     $sb
     *         ->select('u.id')
     *         ->addSelect('p.id')
     *         ->from('users', 'u')
     *         ->leftJoin('u', 'phone', 'u.id = p.user_id');
     * </code>
     *
     * @param  string[] $select the selection expression
     *
     * @return Select instance
     */
    public function addSelect(string ...$select): Select
    {
        $this->select = array_merge($this->select, $select);
        return $this;
    }

    /**
     * Get current select query part
     *
     * @return array
     */
    public function getSelect(): array
    {
        return $this->select;
    }

    /**
     * Specifies a grouping over the results of the query.
     * Replaces any previously specified groupings, if any.
     *
     * Example
     * <code>
     *     $sb = new Select();
     *     $sb
     *         ->select('u.name')
     *         ->from('users', 'u')
     *         ->groupBy('u.id');
     * </code>
     *
     * @param  string[] $groupBy the grouping expression
     *
     * @return Select instance
     */
    public function groupBy(string ...$groupBy): Select
    {
        $this->groupBy = $groupBy;
        return $this;
    }

    /**
     * Adds a grouping expression to the query.
     *
     * Example
     * <code>
     *     $sb = new Select();
     *     $sb
     *         ->select('u.name')
     *         ->from('users', 'u')
     *         ->groupBy('u.lastLogin');
     *         ->addGroupBy('u.createdAt')
     * </code>
     *
     * @param  string[] $groupBy the grouping expression
     *
     * @return Select instance
     */
    public function addGroupBy(string ...$groupBy): Select
    {
        $this->groupBy = array_merge($this->groupBy, $groupBy);
        return $this;
    }

    /**
     * Specifies a restriction over the groups of the query.
     * Replaces any previous having restrictions, if any
     *
     * @param  string[] $conditions the query restriction predicates
     *
     * @return Select
     */
    public function having(...$conditions): Select
    {
        $this->having = $this->prepareCondition($conditions);
        return $this;
    }

    /**
     * Adds a restriction over the groups of the query, forming a logical
     * conjunction with any existing having restrictions
     *
     * @param  string[] $conditions the query restriction predicates
     *
     * @return Select
     */
    public function andHaving(...$conditions): Select
    {
        $condition = $this->prepareCondition($conditions);

        if (
            $this->having instanceof CompositeBuilder
            && $this->having->getType() === 'AND'
        ) {
            $this->having->addPart($condition);
        } else {
            $this->having = new CompositeBuilder([$this->having, $condition]);
        }
        return $this;
    }

    /**
     * Adds a restriction over the groups of the query, forming a logical
     * disjunction with any existing having restrictions
     *
     * @param  string[] $conditions the query restriction predicates
     *
     * @return Select
     */
    public function orHaving(...$conditions): Select
    {
        $condition = $this->prepareCondition($conditions);

        if (
            $this->having instanceof CompositeBuilder
            && $this->having->getType() === 'OR'
        ) {
            $this->having->addPart($condition);
        } else {
            $this->having = new CompositeBuilder([$this->having, $condition], 'OR');
        }
        return $this;
    }

    /**
     * Setup offset like a page number, start from 1
     *
     * @param  integer $page
     *
     * @return Select
     * @throws DbException
     */
    public function setPage(int $page = 1): Select
    {
        if (!$this->limit) {
            throw new DbException('Please setup limit for use method `setPage`');
        }
        $this->offset = $this->limit * ($page - 1);
        return $this;
    }

    /**
     * Prepare Select query part
     *
     * @return string
     */
    protected function prepareSelect(): string
    {
        return 'SELECT ' . implode(', ', $this->select);
    }

    /**
     * prepareWhere
     *
     * @return string
     */
    protected function prepareGroupBy(): string
    {
        return !empty($this->groupBy) ? ' GROUP BY ' . implode(', ', $this->groupBy) : '';
    }

    /**
     * prepareWhere
     *
     * @return string
     */
    protected function prepareHaving(): string
    {
        return $this->having ? ' HAVING ' . $this->having : '';
    }
}


1		<?php
2
3		/**
4		* Bluz Framework Component
5		*
6		* @copyright Bluz PHP Team
7		* @link https://github.com/bluzphp/framework
8		*/
9
10		declare(strict_types=1);
11
12		namespace Bluz\Db\Query;
13
14		use Bluz\Db\Exception\DbException;
15		use Bluz\Proxy\Db;
16
17		/**
18		* Builder of SELECT queries
19		*
20		* @package Bluz\Db\Query
21		*/
22		class Select extends AbstractBuilder
23		{
24		use Traits\From;
25		use Traits\Where;
26		use Traits\Order;
27		use Traits\Limit;
28
29		/**
30		* <code>
31		* [
32		* 'u.id', 'u.name',
33		* 'p.id', 'p.title'
34		* ]
35		* </code>
36		*
37		* @var array[]
38		*/
39		protected $select = [];
40		protected $groupBy = [];
41		protected $having = null;
42
43		/**
44		* @var mixed PDO fetch types or object class
45		*/
46		protected $fetchType = \PDO::FETCH_ASSOC;
47
48		/**
49		* {@inheritdoc}
50		*
51		* @param integer\|string\|object $fetchType
52		*
53		* @return integer\|string\|array
54		*/
55	3	public function execute($fetchType = null)
56		{
57	3	if (!$fetchType) {
58	3	$fetchType = $this->fetchType;
59		}
60
61		switch ($fetchType) {
62	3	case (!is_int($fetchType)):
63	2	return Db::fetchObjects($this->getSql(), $this->params, $fetchType);
64	1	case \PDO::FETCH_CLASS:
65		return Db::fetchObjects($this->getSql(), $this->params);
66	1	case \PDO::FETCH_ASSOC:
67		default:
68	1	return Db::fetchAll($this->getSql(), $this->params);
69		}
70		}
71
72		/**
73		* Setup fetch type, any of PDO, or any Class
74		*
75		* @param string $fetchType
76		*
77		* @return Select instance
78		*/
79	2	public function setFetchType($fetchType): Select
80		{
81	2	$this->fetchType = $fetchType;
82	2	return $this;
83		}
84
85		/**
86		* {@inheritdoc}
87		*/
88	8	public function getSql(): string
89		{
90	8	return $this->prepareSelect()
91	8	. $this->prepareFrom()
92	8	. $this->prepareWhere()
93	8	. $this->prepareGroupBy()
94	8	. $this->prepareHaving()
95	8	. $this->prepareOrderBy()
96	8	. $this->prepareLimit();
97		}
98
99		/**
100		* Specifies an item that is to be returned in the query result
101		* Replaces any previously specified selections, if any
102		*
103		* Example
104		* <code>
105		* $sb = new Select();
106		* $sb
107		* ->select('u.id', 'p.id')
108		* ->from('users', 'u')
109		* ->leftJoin('u', 'phone', 'p', 'u.id = p.user_id');
110		* </code>
111		*
112		* @param string[] $select the selection expressions
113		*
114		* @return Select instance
115		*/
116	9	public function select(...$select): Select
117		{
118	9	$this->select = $select;
		0 ignored issues – show Documentation Bug introduced 2019-02-08 10:45 UTC by Report Bug Copy Issue Report It seems like `$select` of type `array<integer,string>` is incompatible with the declared type `array<mixed,array>` of property `$select`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
119	9	return $this;
120		}
121
122		/**
123		* Adds an item that is to be returned in the query result.
124		*
125		* Example
126		* <code>
127		* $sb = new Select();
128		* $sb
129		* ->select('u.id')
130		* ->addSelect('p.id')
131		* ->from('users', 'u')
132		* ->leftJoin('u', 'phone', 'u.id = p.user_id');
133		* </code>
134		*
135		* @param string[] $select the selection expression
136		*
137		* @return Select instance
138		*/
139	1	public function addSelect(string ...$select): Select
140		{
141	1	$this->select = array_merge($this->select, $select);
142	1	return $this;
143		}
144
145		/**
146		* Get current select query part
147		*
148		* @return array
149		*/
150	3	public function getSelect(): array
151		{
152	3	return $this->select;
153		}
154
155		/**
156		* Specifies a grouping over the results of the query.
157		* Replaces any previously specified groupings, if any.
158		*
159		* Example
160		* <code>
161		* $sb = new Select();
162		* $sb
163		* ->select('u.name')
164		* ->from('users', 'u')
165		* ->groupBy('u.id');
166		* </code>
167		*
168		* @param string[] $groupBy the grouping expression
169		*
170		* @return Select instance
171		*/
172	1	public function groupBy(string ...$groupBy): Select
173		{
174	1	$this->groupBy = $groupBy;
175	1	return $this;
176		}
177
178		/**
179		* Adds a grouping expression to the query.
180		*
181		* Example
182		* <code>
183		* $sb = new Select();
184		* $sb
185		* ->select('u.name')
186		* ->from('users', 'u')
187		* ->groupBy('u.lastLogin');
188		* ->addGroupBy('u.createdAt')
189		* </code>
190		*
191		* @param string[] $groupBy the grouping expression
192		*
193		* @return Select instance
194		*/
195	1	public function addGroupBy(string ...$groupBy): Select
196		{
197	1	$this->groupBy = array_merge($this->groupBy, $groupBy);
198	1	return $this;
199		}
200
201		/**
202		* Specifies a restriction over the groups of the query.
203		* Replaces any previous having restrictions, if any
204		*
205		* @param string[] $conditions the query restriction predicates
206		*
207		* @return Select
208		*/
209	1	public function having(...$conditions): Select
210		{
211	1	$this->having = $this->prepareCondition($conditions);
212	1	return $this;
213		}
214
215		/**
216		* Adds a restriction over the groups of the query, forming a logical
217		* conjunction with any existing having restrictions
218		*
219		* @param string[] $conditions the query restriction predicates
220		*
221		* @return Select
222		*/
223	1	public function andHaving(...$conditions): Select
224		{
225	1	$condition = $this->prepareCondition($conditions);
226
227		if (
228	1	$this->having instanceof CompositeBuilder
229	1	&& $this->having->getType() === 'AND'
230		) {
231		$this->having->addPart($condition);
232		} else {
233	1	$this->having = new CompositeBuilder([$this->having, $condition]);
234		}
235	1	return $this;
236		}
237
238		/**
239		* Adds a restriction over the groups of the query, forming a logical
240		* disjunction with any existing having restrictions
241		*
242		* @param string[] $conditions the query restriction predicates
243		*
244		* @return Select
245		*/
246	1	public function orHaving(...$conditions): Select
247		{
248	1	$condition = $this->prepareCondition($conditions);
249
250		if (
251	1	$this->having instanceof CompositeBuilder
252	1	&& $this->having->getType() === 'OR'
253		) {
254		$this->having->addPart($condition);
255		} else {
256	1	$this->having = new CompositeBuilder([$this->having, $condition], 'OR');
257		}
258	1	return $this;
259		}
260
261		/**
262		* Setup offset like a page number, start from 1
263		*
264		* @param integer $page
265		*
266		* @return Select
267		* @throws DbException
268		*/
269	1	public function setPage(int $page = 1): Select
270		{
271	1	if (!$this->limit) {
272		throw new DbException('Please setup limit for use method `setPage`');
273		}
274	1	$this->offset = $this->limit * ($page - 1);
275	1	return $this;
276		}
277
278		/**
279		* Prepare Select query part
280		*
281		* @return string
282		*/
283	8	protected function prepareSelect(): string
284		{
285	8	return 'SELECT ' . implode(', ', $this->select);
286		}
287
288		/**
289		* prepareWhere
290		*
291		* @return string
292		*/
293	8	protected function prepareGroupBy(): string
294		{
295	8	return !empty($this->groupBy) ? ' GROUP BY ' . implode(', ', $this->groupBy) : '';
296		}
297
298		/**
299		* prepareWhere
300		*
301		* @return string
302		*/
303	8	protected function prepareHaving(): string
304		{
305	8	return $this->having ? ' HAVING ' . $this->having : '';
306		}
307		}
308

bluzphp / framework

Push — master ( e47c19...3aaaf2 )

Select::addSelect() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like