AbstractQuery::getStatement() - Code Metrics - Inspection of "Not using develop-2, but 2.x branch" - auraphp/Aura.SqlQuery - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 2.x (#106)

by Hari

created 2016-09-05 14:14 UTC

AbstractQuery::getStatement() A

↳ Parent: AbstractQuery

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	1	Features	0

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

<?php
/**
 *
 * This file is part of Aura for PHP.
 *
 * @license http://opensource.org/licenses/bsd-license.php BSD
 *
 */
namespace Aura\SqlQuery;

use Aura\SqlQuery\Common\LimitInterface;
use Aura\SqlQuery\Common\LimitOffsetInterface;
use Aura\SqlQuery\Common\SubselectInterface;

/**
 *
 * Abstract query object.
 *
 * @package Aura.SqlQuery
 *
 */
abstract class AbstractQuery
{
    /**
     *
     * Data to be bound to the query.
     *
     * @var array
     *
     */
    protected $bind_values = array();

    /**
     *
     * The list of WHERE conditions.
     *
     * @var array
     *
     */
    protected $where = array();

    /**
     *
     * ORDER BY these columns.
     *
     * @var array
     *
     */
    protected $order_by = array();

    /**
     *
     * The number of rows to select
     *
     * @var int
     *
     */
    protected $limit = 0;

    /**
     *
     * Return rows after this offset.
     *
     * @var int
     *
     */
    protected $offset = 0;

    /**
     *
     * The list of flags.
     *
     * @var array
     *
     */
    protected $flags = array();

    /**
     *
     * A helper for quoting identifier names.
     *
     * @var Quoter
     *
     */
    protected $quoter;

    /**
     *
     * Prefix to use on placeholders for "sequential" bound values; used for
     * deconfliction when merging bound values from sub-selects, etc.
     *
     * @var mixed
     *
     */
    protected $seq_bind_prefix = '';

    /**
     *
     * Constructor.
     *
     * @param Quoter $quoter A helper for quoting identifier names.
     *
     * @param string $seq_bind_prefix A prefix for rewritten sequential-binding
     * placeholders (@see getSeqPlaceholder()).
     *
     */
    public function __construct(Quoter $quoter, $seq_bind_prefix = '')
    {
        $this->quoter = $quoter;
        $this->seq_bind_prefix = $seq_bind_prefix;
    }

    /**
     *
     * Returns the prefix for rewritten sequential-binding placeholders
     * (@see getSeqPlaceholder()).
     *
     * @return string
     *
     */
    public function getSeqBindPrefix()
    {
        return $this->seq_bind_prefix;
    }

    /**
     *
     * Returns this query object as an SQL statement string.
     *
     * @return string
     *
     */
    public function __toString()
    {
        return $this->getStatement();
    }

    /**
     *
     * Returns this query object as an SQL statement string.
     *
     * @return string
     *
     */
    public function getStatement()
    {
        return $this->build();
    }

    /**
     *
     * Builds this query object into a string.
     *
     * @return string
     *
     */
    abstract protected function build();

    /**
     *
     * Returns the prefix to use when quoting identifier names.
     *
     * @return string
     *
     */
    public function getQuoteNamePrefix()
    {
        return $this->quoter->getQuoteNamePrefix();
    }

    /**
     *
     * Returns the suffix to use when quoting identifier names.
     *
     * @return string
     *
     */
    public function getQuoteNameSuffix()
    {
        return $this->quoter->getQuoteNameSuffix();
    }

    /**
     *
     * Returns an array as an indented comma-separated values string.
     *
     * @param array $list The values to convert.
     *
     * @return string
     *
     */
    protected function indentCsv(array $list)
    {
        return PHP_EOL . '    '
             . implode(',' . PHP_EOL . '    ', $list);
    }

    /**
     *
     * Returns an array as an indented string.
     *
     * @param array $list The values to convert.
     *
     * @return string
     *
     */
    protected function indent(array $list)
    {
        return PHP_EOL . '    '
             . implode(PHP_EOL . '    ', $list);
    }

    /**
     *
     * Binds multiple values to placeholders; merges with existing values.
     *
     * @param array $bind_values Values to bind to placeholders.
     *
     * @return $this
     *
     */
    public function bindValues(array $bind_values)
    {
        // array_merge() renumbers integer keys, which is bad for
        // question-mark placeholders
        foreach ($bind_values as $key => $val) {
            $this->bindValue($key, $val);
        }
        return $this;
    }

    /**
     *
     * Binds a single value to the query.
     *
     * @param string $name The placeholder name or number.
     *
     * @param mixed $value The value to bind to the placeholder.
     *
     * @return $this
     *
     */
    public function bindValue($name, $value)
    {
        $this->bind_values[$name] = $value;
        return $this;
    }

    /**
     *
     * Gets the values to bind to placeholders.
     *
     * @return array
     *
     */
    public function getBindValues()
    {
        return $this->bind_values;
    }

    /**
     *
     * Reset all values bound to named placeholders.
     *
     * @return $this
     *
     */
    public function resetBindValues()
    {
        $this->bind_values = array();
        return $this;
    }

    /**
     *
     * Builds the flags as a space-separated string.
     *
     * @return string
     *
     */
    protected function buildFlags()
    {
        if (! $this->flags) {

            return ''; // not applicable
        }

        return ' ' . implode(' ', array_keys($this->flags));
    }

    /**
     *
     * Sets or unsets specified flag.
     *
     * @param string $flag Flag to set or unset
     *
     * @param bool $enable Flag status - enabled or not (default true)
     *
     * @return null
     *
     */
    protected function setFlag($flag, $enable = true)
    {
        if ($enable) {
            $this->flags[$flag] = true;
        } else {
            unset($this->flags[$flag]);
        }
    }

    /**
     *
     * Reset all query flags.
     *
     * @return $this
     *
     */
    public function resetFlags()
    {
        $this->flags = array();
        return $this;
    }

    /**
     *
     * Adds a WHERE condition to the query by AND or OR. If the condition has
     * ?-placeholders, additional arguments to the method will be bound to
     * those placeholders sequentially.
     *
     * @param string $andor Add the condition using this operator, typically
     * 'AND' or 'OR'.
     *
     * @param array $args Arguments for adding the condition.
     *
     * @return $this
     *
     */
    protected function addWhere($andor, $args)
    {
        $this->addClauseCondWithBind('where', $andor, $args);
        return $this;
    }

    /**
     *
     * Adds conditions and binds values to a clause.
     *
     * @param string $clause The clause to work with, typically 'where' or
     * 'having'.
     *
     * @param string $andor Add the condition using this operator, typically
     * 'AND' or 'OR'.
     *
     * @param array $args Arguments for adding the condition.
     *
     * @return null
     *
     */
    protected function addClauseCondWithBind($clause, $andor, $args)
    {
        // remove the condition from the args and quote names in it
        $cond = array_shift($args);
        $cond = $this->rebuildCondAndBindValues($cond, $args);

        // add condition to clause; $this->where
        $clause =& $this->$clause;
        if ($clause) {
            $clause[] = "$andor $cond";
        } else {
            $clause[] = $cond;
        }
    }

    /**
     *
     * Rebuilds a condition string, replacing sequential placeholders with
     * named placeholders, and binding the sequential values to the named
     * placeholders.
     *
     * @param string $cond The condition with sequential placeholders.
     *
     * @param array $bind_values The values to bind to the sequential
     * placeholders under their named versions.
     *
     * @return string The rebuilt condition string.
     *
     */
    protected function rebuildCondAndBindValues($cond, array $bind_values)
    {
        $cond = $this->quoter->quoteNamesIn($cond);

        // bind values against ?-mark placeholders, but because PDO is finicky
        // about the numbering of sequential placeholders, convert each ?-mark
        // to a named placeholder
        $parts = preg_split('/(\?)/', $cond, null, PREG_SPLIT_DELIM_CAPTURE);
        foreach ($parts as $key => $val) {
            if ($val != '?') {
                continue;
            }

            $bind_value = array_shift($bind_values);
            if ($bind_value instanceof SubselectInterface) {
                $parts[$key] = $bind_value->getStatement();
                $this->bind_values = array_merge(
                    $this->bind_values,
                    $bind_value->getBindValues()
                );
                continue;
            }

            $placeholder = $this->getSeqPlaceholder();
            $parts[$key] = ':' . $placeholder;
            $this->bind_values[$placeholder] = $bind_value;
        }

        $cond = implode('', $parts);
        return $cond;
    }

    /**
     *
     * Gets the current sequential placeholder name.
     *
     * @return string
     *
     */
    protected function getSeqPlaceholder()
    {
        $i = count($this->bind_values) + 1;
        return $this->seq_bind_prefix . "_{$i}_";
    }

    /**
     *
     * Builds the `WHERE` clause of the statement.
     *
     * @return string
     *
     */
    protected function buildWhere()
    {
        if (! $this->where) {

            return ''; // not applicable
        }

        return PHP_EOL . 'WHERE' . $this->indent($this->where);
    }

    /**
     *
     * Adds a column order to the query.
     *
     * @param array $spec The columns and direction to order by.
     *
     * @return $this
     *
     */
    protected function addOrderBy(array $spec)
    {
        foreach ($spec as $col) {
            $this->order_by[] = $this->quoter->quoteNamesIn($col);
        }
        return $this;
    }

    /**
     *
     * Builds the `ORDER BY ...` clause of the statement.
     *
     * @return string
     *
     */
    protected function buildOrderBy()
    {
        if (! $this->order_by) {

            return ''; // not applicable
        }

        return PHP_EOL . 'ORDER BY' . $this->indentCsv($this->order_by);
    }

    /**
     *
     * Builds the `LIMIT ... OFFSET` clause of the statement.
     *
     * Note that this will allow OFFSET values with a LIMIT.
     *
     * @return string
     *
     */
    protected function buildLimit()
    {
        $clause = '';
        $limit = $this instanceof LimitInterface && $this->limit;
        $offset = $this instanceof LimitOffsetInterface && $this->offset;

        if ($limit) {
            $clause .= "LIMIT {$this->limit}";
        }

        if ($offset) {
            $clause .= " OFFSET {$this->offset}";
        }

        if ($clause) {
            $clause = PHP_EOL . trim($clause);
        }

        return $clause;
    }
}


1		<?php
2		/**
3		*
4		* This file is part of Aura for PHP.
5		*
6		* @license http://opensource.org/licenses/bsd-license.php BSD
7		*
8		*/
9		namespace Aura\SqlQuery;
10
11		use Aura\SqlQuery\Common\LimitInterface;
12		use Aura\SqlQuery\Common\LimitOffsetInterface;
13		use Aura\SqlQuery\Common\SubselectInterface;
14
15		/**
16		*
17		* Abstract query object.
18		*
19		* @package Aura.SqlQuery
20		*
21		*/
22		abstract class AbstractQuery
23		{
24		/**
25		*
26		* Data to be bound to the query.
27		*
28		* @var array
29		*
30		*/
31		protected $bind_values = array();
32
33		/**
34		*
35		* The list of WHERE conditions.
36		*
37		* @var array
38		*
39		*/
40		protected $where = array();
41
42		/**
43		*
44		* ORDER BY these columns.
45		*
46		* @var array
47		*
48		*/
49		protected $order_by = array();
50
51		/**
52		*
53		* The number of rows to select
54		*
55		* @var int
56		*
57		*/
58		protected $limit = 0;
59
60		/**
61		*
62		* Return rows after this offset.
63		*
64		* @var int
65		*
66		*/
67		protected $offset = 0;
68
69		/**
70		*
71		* The list of flags.
72		*
73		* @var array
74		*
75		*/
76		protected $flags = array();
77
78		/**
79		*
80		* A helper for quoting identifier names.
81		*
82		* @var Quoter
83		*
84		*/
85		protected $quoter;
86
87		/**
88		*
89		* Prefix to use on placeholders for "sequential" bound values; used for
90		* deconfliction when merging bound values from sub-selects, etc.
91		*
92		* @var mixed
93		*
94		*/
95		protected $seq_bind_prefix = '';
96
97		/**
98		*
99		* Constructor.
100		*
101		* @param Quoter $quoter A helper for quoting identifier names.
102		*
103		* @param string $seq_bind_prefix A prefix for rewritten sequential-binding
104		* placeholders (@see getSeqPlaceholder()).
105		*
106		*/
107	376	public function __construct(Quoter $quoter, $seq_bind_prefix = '')
108		{
109	376	$this->quoter = $quoter;
110	376	$this->seq_bind_prefix = $seq_bind_prefix;
111		}
112
113		/**
114		*
115		* Returns the prefix for rewritten sequential-binding placeholders
116		* (@see getSeqPlaceholder()).
117		*
118		* @return string
119		*
120		*/
121		public function getSeqBindPrefix()
122		{
123		return $this->seq_bind_prefix;
124		}
125
126		/**
127		*
128		* Returns this query object as an SQL statement string.
129		*
130		* @return string
131		*
132		*/
133	5	public function __toString()
134		{
135	5	return $this->getStatement();
136		}
137
138		/**
139		*
140		* Returns this query object as an SQL statement string.
141		*
142		* @return string
143		*
144		*/
145		public function getStatement()
146		{
147		return $this->build();
148		}
149
150		/**
151		*
152		* Builds this query object into a string.
153		*
154		* @return string
155		*
156		*/
157		abstract protected function build();
158
159		/**
160		*
161		* Returns the prefix to use when quoting identifier names.
162		*
163		* @return string
164		*
165		*/
166		public function getQuoteNamePrefix()
167		{
168		return $this->quoter->getQuoteNamePrefix();
169		}
170
171		/**
172		*
173		* Returns the suffix to use when quoting identifier names.
174		*
175		* @return string
176		*
177		*/
178		public function getQuoteNameSuffix()
179		{
180		return $this->quoter->getQuoteNameSuffix();
181		}
182
183		/**
184		*
185		* Returns an array as an indented comma-separated values string.
186		*
187		* @param array $list The values to convert.
188		*
189		* @return string
190		*
191		*/
192	61	protected function indentCsv(array $list)
193		{
194	61	return PHP_EOL . ' '
195		. implode(',' . PHP_EOL . ' ', $list);
196	61	}
197
198		/**
199		*
200		* Returns an array as an indented string.
201		*
202		* @param array $list The values to convert.
203		*
204		* @return string
205		*
206		*/
207	50	protected function indent(array $list)
208		{
209	50	return PHP_EOL . ' '
210		. implode(PHP_EOL . ' ', $list);
211	50	}
212
213		/**
214		*
215		* Binds multiple values to placeholders; merges with existing values.
216		*
217		* @param array $bind_values Values to bind to placeholders.
218		*
219		* @return $this
220		*
221		*/
222	16	public function bindValues(array $bind_values)
223		{
224		// array_merge() renumbers integer keys, which is bad for
225		// question-mark placeholders
226		foreach ($bind_values as $key => $val) {
227		$this->bindValue($key, $val);
228		}
229	16	return $this;
230	16	}
231
232		/**
233		*
234		* Binds a single value to the query.
235		*
236		* @param string $name The placeholder name or number.
237		*
238		* @param mixed $value The value to bind to the placeholder.
239		*
240		* @return $this
241		*
242		*/
243	21	public function bindValue($name, $value)
244		{
245	21	$this->bind_values[$name] = $value;
246	21	return $this;
247		}
248
249		/**
250		*
251		* Gets the values to bind to placeholders.
252		*
253		* @return array
254		*
255		*/
256	106	public function getBindValues()
257		{
258	106	return $this->bind_values;
259		}
260
261		/**
262		*
263		* Reset all values bound to named placeholders.
264		*
265		* @return $this
266		*
267		*/
268		public function resetBindValues()
269		{
270		$this->bind_values = array();
271		return $this;
272		}
273
274		/**
275		*
276		* Builds the flags as a space-separated string.
277		*
278		* @return string
279		*
280		*/
281	212	protected function buildFlags()
282		{
283	212	if (! $this->flags) {
		0 ignored issues – show Bug Best Practice introduced 2016-02-03 01:44 UTC by Report Bug Copy Issue Report The expression `$this->flags` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
284	174	return ''; // not applicable
285		}
286
287		return ' ' . implode(' ', array_keys($this->flags));
288		}
289
290		/**
291		*
292		* Sets or unsets specified flag.
293		*
294		* @param string $flag Flag to set or unset
295		*
296		* @param bool $enable Flag status - enabled or not (default true)
297		*
298		* @return null
299		*
300		*/
301	37	protected function setFlag($flag, $enable = true)
302		{
303	32	if ($enable) {
304	37	$this->flags[$flag] = true;
305		} else {
306	5	unset($this->flags[$flag]);
307	37	}
308	32	}
309
310		/**
311		*
312		* Reset all query flags.
313		*
314		* @return $this
315		*
316		*/
317	15	public function resetFlags()
318		{
319	15	$this->flags = array();
320	15	return $this;
321		}
322
323		/**
324		*
325		* Adds a WHERE condition to the query by AND or OR. If the condition has
326		* ?-placeholders, additional arguments to the method will be bound to
327		* those placeholders sequentially.
328		*
329		* @param string $andor Add the condition using this operator, typically
330		* 'AND' or 'OR'.
331		*
332		* @param array $args Arguments for adding the condition.
333		*
334		* @return $this
335		*
336		*/
337	11	protected function addWhere($andor, $args)
338		{
339		$this->addClauseCondWithBind('where', $andor, $args);
340	11	return $this;
341		}
342
343		/**
344		*
345		* Adds conditions and binds values to a clause.
346		*
347		* @param string $clause The clause to work with, typically 'where' or
348		* 'having'.
349		*
350		* @param string $andor Add the condition using this operator, typically
351		* 'AND' or 'OR'.
352		*
353		* @param array $args Arguments for adding the condition.
354		*
355		* @return null
356		*
357		*/
358	50	protected function addClauseCondWithBind($clause, $andor, $args)
359		{
360		// remove the condition from the args and quote names in it
361		$cond = array_shift($args);
362		$cond = $this->rebuildCondAndBindValues($cond, $args);
363
364		// add condition to clause; $this->where
365	6	$clause =& $this->$clause;
366	6	if ($clause) {
367	25	$clause[] = "$andor $cond";
368		} else {
369	50	$clause[] = $cond;
370	25	}
371	6	}
372
373		/**
374		*
375		* Rebuilds a condition string, replacing sequential placeholders with
376		* named placeholders, and binding the sequential values to the named
377		* placeholders.
378		*
379		* @param string $cond The condition with sequential placeholders.
380		*
381		* @param array $bind_values The values to bind to the sequential
382		* placeholders under their named versions.
383		*
384		* @return string The rebuilt condition string.
385		*
386		*/
387	31	protected function rebuildCondAndBindValues($cond, array $bind_values)
388		{
389		$cond = $this->quoter->quoteNamesIn($cond);
390
391		// bind values against ?-mark placeholders, but because PDO is finicky
392		// about the numbering of sequential placeholders, convert each ?-mark
393		// to a named placeholder
394		$parts = preg_split('/(\?)/', $cond, null, PREG_SPLIT_DELIM_CAPTURE);
395		foreach ($parts as $key => $val) {
396	10	if ($val != '?') {
397	10	continue;
398		}
399
400		$bind_value = array_shift($bind_values);
401	31	if ($bind_value instanceof SubselectInterface) {
402		$parts[$key] = $bind_value->getStatement();
403	10	$this->bind_values = array_merge(
404	10	$this->bind_values,
405	10	$bind_value->getBindValues()
406		);
407	10	continue;
408		}
409
410		$placeholder = $this->getSeqPlaceholder();
411	26	$parts[$key] = ':' . $placeholder;
412	26	$this->bind_values[$placeholder] = $bind_value;
413		}
414
415		$cond = implode('', $parts);
416	21	return $cond;
417	21	}
418
419		/**
420		*
421		* Gets the current sequential placeholder name.
422		*
423		* @return string
424		*
425		*/
426	26	protected function getSeqPlaceholder()
427		{
428		$i = count($this->bind_values) + 1;
429	26	return $this->seq_bind_prefix . "_{$i}_";
430		}
431
432		/**
433		*
434		* Builds the `WHERE` clause of the statement.
435		*
436		* @return string
437		*
438		*/
439	166	protected function buildWhere()
440		{
441	166	if (! $this->where) {
		0 ignored issues – show Bug Best Practice introduced 2016-02-03 01:44 UTC by Report Bug Copy Issue Report The expression `$this->where` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
442	126	return ''; // not applicable
443		}
444
445		return PHP_EOL . 'WHERE' . $this->indent($this->where);
446		}
447
448		/**
449		*
450		* Adds a column order to the query.
451		*
452		* @param array $spec The columns and direction to order by.
453		*
454		* @return $this
455		*
456		*/
457	9	protected function addOrderBy(array $spec)
458		{
459		foreach ($spec as $col) {
460		$this->order_by[] = $this->quoter->quoteNamesIn($col);
461		}
462	9	return $this;
463	9	}
464
465		/**
466		*
467		* Builds the `ORDER BY ...` clause of the statement.
468		*
469		* @return string
470		*
471		*/
472	166	protected function buildOrderBy()
473		{
474	166	if (! $this->order_by) {
		0 ignored issues – show Bug Best Practice introduced 2016-02-03 01:44 UTC by Report Bug Copy Issue Report The expression `$this->order_by` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
475	157	return ''; // not applicable
476		}
477
478		return PHP_EOL . 'ORDER BY' . $this->indentCsv($this->order_by);
479		}
480
481		/**
482		*
483		* Builds the `LIMIT ... OFFSET` clause of the statement.
484		*
485		* Note that this will allow OFFSET values with a LIMIT.
486		*
487		* @return string
488		*
489		*/
490	140	protected function buildLimit()
491		{
492	140	$clause = '';
493	140	$limit = $this instanceof LimitInterface && $this->limit;
494	140	$offset = $this instanceof LimitOffsetInterface && $this->offset;
495
496	140	if ($limit) {
497	15	$clause .= "LIMIT {$this->limit}";
498		}
499
500	140	if ($offset) {
501	10	$clause .= " OFFSET {$this->offset}";
502		}
503
504	140	if ($clause) {
505		$clause = PHP_EOL . trim($clause);
506		}
507
508	140	return $clause;
509		}
510		}
511

auraphp / Aura.SqlQuery

Pull Request — 2.x (#106)

AbstractQuery::getStatement() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like