AbstractQuery::rebuildCondAndBindValues() - Code Metrics - Inspection of "edits and additions to @yespire reset functionalit..." - auraphp/Aura.SqlQuery - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — resets ( d2f77b )

by Paul

created 2016-05-19 16:56 UTC

AbstractQuery::rebuildCondAndBindValues() B

↳ Parent: AbstractQuery

Complexity

Conditions	4
Paths	4

Size

Total Lines	31
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	20
CRAP Score	4

Importance

Changes	3
Bugs	0	Features	1

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

<?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;
    }

    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.
     *
     * @return string
     *
     */
    protected function buildLimit()
    {
        $has_limit = $this instanceof LimitInterface;
        $has_offset = $this instanceof LimitOffsetInterface;

        if ($has_offset && $this->limit) {
            $clause = PHP_EOL . "LIMIT {$this->limit}";
            if ($this->offset) {
                $clause .= " OFFSET {$this->offset}";
            }
            return $clause;
        } elseif ($has_limit && $this->limit) {
            return PHP_EOL . "LIMIT {$this->limit}";
        }

        return ''; // not applicable
    }
}


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	387	public function __construct(Quoter $quoter, $seq_bind_prefix = '')
108		{
109	387	$this->quoter = $quoter;
110	387	$this->seq_bind_prefix = $seq_bind_prefix;
111	387	}
112
113		/**
114		*
115		* Returns the prefix for rewritten sequential-binding placeholders
116		* (@see getSeqPlaceholder()).
117		*
118		* @return string
119		*
120		*/
121	1	public function getSeqBindPrefix()
122		{
123	1	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	232	public function __toString()
134		{
135	232	return $this->getStatement();
136		}
137
138		/**
139		*
140		* Returns this query object as an SQL statement string.
141		*
142		* @return string
143		*
144		*/
145	68	public function getStatement()
146		{
147	68	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	241	public function getQuoteNamePrefix()
167		{
168	241	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	241	public function getQuoteNameSuffix()
179		{
180	241	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	209	protected function indentCsv(array $list)
193		{
194	209	return PHP_EOL . ' '
195	209	. implode(',' . PHP_EOL . ' ', $list);
196		}
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	71	protected function indent(array $list)
208		{
209	71	return PHP_EOL . ' '
210	71	. implode(PHP_EOL . ' ', $list);
211		}
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	31	public function bindValues(array $bind_values)
223		{
224		// array_merge() renumbers integer keys, which is bad for
225		// question-mark placeholders
226	31	foreach ($bind_values as $key => $val) {
227	31	$this->bindValue($key, $val);
228	31	}
229	31	return $this;
230		}
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	72	public function bindValue($name, $value)
244		{
245	72	$this->bind_values[$name] = $value;
246	72	return $this;
247		}
248
249		/**
250		*
251		* Gets the values to bind to placeholders.
252		*
253		* @return array
254		*
255		*/
256	126	public function getBindValues()
257		{
258	126	return $this->bind_values;
259		}
260
261		public function resetBindValues()
262		{
263		$this->bind_values = array();
264		return $this;
265		}
266
267		/**
268		*
269		* Builds the flags as a space-separated string.
270		*
271		* @return string
272		*
273		*/
274	242	protected function buildFlags()
275		{
276	242	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...
277	204	return ''; // not applicable
278		}
279
280	38	return ' ' . implode(' ', array_keys($this->flags));
281		}
282
283		/**
284		*
285		* Sets or unsets specified flag.
286		*
287		* @param string $flag Flag to set or unset
288		*
289		* @param bool $enable Flag status - enabled or not (default true)
290		*
291		* @return null
292		*
293		*/
294	43	protected function setFlag($flag, $enable = true)
295		{
296	43	if ($enable) {
297	43	$this->flags[$flag] = true;
298	43	} else {
299	5	unset($this->flags[$flag]);
300		}
301	43	}
302
303		/**
304		*
305		* Reset all query flags.
306		*
307		* @return $this
308		*
309		*/
310	15	public function resetFlags()
311		{
312	15	$this->flags = array();
313	15	return $this;
314		}
315
316		/**
317		*
318		* Adds a WHERE condition to the query by AND or OR. If the condition has
319		* ?-placeholders, additional arguments to the method will be bound to
320		* those placeholders sequentially.
321		*
322		* @param string $andor Add the condition using this operator, typically
323		* 'AND' or 'OR'.
324		*
325		* @param array $args Arguments for adding the condition.
326		*
327		* @return $this
328		*
329		*/
330	60	protected function addWhere($andor, $args)
331		{
332	60	$this->addClauseCondWithBind('where', $andor, $args);
333	60	return $this;
334		}
335
336		/**
337		*
338		* Adds conditions and binds values to a clause.
339		*
340		* @param string $clause The clause to work with, typically 'where' or
341		* 'having'.
342		*
343		* @param string $andor Add the condition using this operator, typically
344		* 'AND' or 'OR'.
345		*
346		* @param array $args Arguments for adding the condition.
347		*
348		* @return null
349		*
350		*/
351	70	protected function addClauseCondWithBind($clause, $andor, $args)
352		{
353		// remove the condition from the args and quote names in it
354	70	$cond = array_shift($args);
355	70	$cond = $this->rebuildCondAndBindValues($cond, $args);
356
357		// add condition to clause; $this->where
358	70	$clause =& $this->$clause;
359	70	if ($clause) {
360	49	$clause[] = "$andor $cond";
361	49	} else {
362	70	$clause[] = $cond;
363		}
364	70	}
365
366		/**
367		*
368		* Rebuilds a condition string, replacing sequential placeholders with
369		* named placeholders, and binding the sequential values to the named
370		* placeholders.
371		*
372		* @param string $cond The condition with sequential placeholders.
373		*
374		* @param array $bind_values The values to bind to the sequential
375		* placeholders under their named versions.
376		*
377		* @return string The rebuilt condition string.
378		*
379		*/
380	110	protected function rebuildCondAndBindValues($cond, array $bind_values)
381		{
382	110	$cond = $this->quoter->quoteNamesIn($cond);
383
384		// bind values against ?-mark placeholders, but because PDO is finicky
385		// about the numbering of sequential placeholders, convert each ?-mark
386		// to a named placeholder
387	110	$parts = preg_split('/(\?)/', $cond, null, PREG_SPLIT_DELIM_CAPTURE);
388	110	foreach ($parts as $key => $val) {
389	110	if ($val != '?') {
390	110	continue;
391		}
392
393	80	$bind_value = array_shift($bind_values);
394	80	if ($bind_value instanceof SubselectInterface) {
395	10	$parts[$key] = $bind_value->getStatement();
396	10	$this->bind_values = array_merge(
397	10	$this->bind_values,
398	10	$bind_value->getBindValues()
399	10	);
400	10	continue;
401		}
402
403	75	$placeholder = $this->getSeqPlaceholder();
404	75	$parts[$key] = ':' . $placeholder;
405	75	$this->bind_values[$placeholder] = $bind_value;
406	110	}
407
408	110	$cond = implode('', $parts);
409	110	return $cond;
410		}
411
412		/**
413		*
414		* Gets the current sequential placeholder name.
415		*
416		* @return string
417		*
418		*/
419	75	protected function getSeqPlaceholder()
420		{
421	75	$i = count($this->bind_values) + 1;
422	75	return $this->seq_bind_prefix . "_{$i}_";
423		}
424
425		/**
426		*
427		* Builds the `WHERE` clause of the statement.
428		*
429		* @return string
430		*
431		*/
432	196	protected function buildWhere()
433		{
434	196	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...
435	141	return ''; // not applicable
436		}
437
438	60	return PHP_EOL . 'WHERE' . $this->indent($this->where);
439		}
440
441		/**
442		*
443		* Adds a column order to the query.
444		*
445		* @param array $spec The columns and direction to order by.
446		*
447		* @return $this
448		*
449		*/
450	9	protected function addOrderBy(array $spec)
451		{
452	9	foreach ($spec as $col) {
453	9	$this->order_by[] = $this->quoter->quoteNamesIn($col);
454	9	}
455	9	return $this;
456		}
457
458		/**
459		*
460		* Builds the `ORDER BY ...` clause of the statement.
461		*
462		* @return string
463		*
464		*/
465	196	protected function buildOrderBy()
466		{
467	196	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...
468	187	return ''; // not applicable
469		}
470
471	9	return PHP_EOL . 'ORDER BY' . $this->indentCsv($this->order_by);
472		}
473
474		/**
475		*
476		* Builds the `LIMIT ... OFFSET` clause of the statement.
477		*
478		* @return string
479		*
480		*/
481	164	protected function buildLimit()
482		{
483	164	$has_limit = $this instanceof LimitInterface;
484	164	$has_offset = $this instanceof LimitOffsetInterface;
485
486	164	if ($has_offset && $this->limit) {
487	15	$clause = PHP_EOL . "LIMIT {$this->limit}";
488	15	if ($this->offset) {
489	10	$clause .= " OFFSET {$this->offset}";
490	10	}
491	15	return $clause;
492	149	} elseif ($has_limit && $this->limit) {
493	4	return PHP_EOL . "LIMIT {$this->limit}";
494		}
495
496	145	return ''; // not applicable
497		}
498		}
499

auraphp / Aura.SqlQuery

Push — resets ( d2f77b )

AbstractQuery::rebuildCondAndBindValues() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like