AbstractQuery::__toString() - Code Metrics - Inspection of "3.x: Named placeholders only for where() et al. co..." - auraphp/Aura.SqlQuery - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 3.x (#134)

by Paul

created 2017-03-22 14:15 UTC

AbstractQuery::__toString() A

↳ Parent: AbstractQuery

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?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\SelectInterface;
use Aura\SqlQuery\Common\QuoterInterface;

/**
 *
 * 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 list of flags.
     *
     * @var array
     *
     */
    protected $flags = array();

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

    /**
     *
     * Constructor.
     *
     * @param Quoter $quoter A helper for quoting identifier names.
     *
     */
    public function __construct(QuoterInterface $quoter, $builder)
    {
        $this->quoter = $quoter;

        $this->builder = $builder;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     *
     * 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();
    }

    /**
     *
     * 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;
    }

    /**
     *
     * 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]);
        }
    }

    /**
     *
     * Returns true if the specified flag was enabled by setFlag().
     *
     * @param string $flag Flag to check
     *
     * @return bool
     *
     */
    protected function hasFlag($flag)
    {
        return isset($this->flags[$flag]);
    }

    /**
     *
     * Reset all query flags.
     *
     * @return $this
     *
     */
    public function resetFlags()
    {
        $this->flags = array();
        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 string $cond The WHERE condition.
     *
     * @param array $bind arguments to bind to placeholders
     *
     * @return null
     *
     */
    protected function addClauseCondWithBind($clause, $andor, $cond, $bind)
    {
        $cond = $this->quoter->quoteNamesIn($cond);
        $cond = $this->rebuildCondAndBindValues($cond, $bind);

        $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)
    {
        $selects = [];

        foreach ($bind_values as $key => $val) {
            if ($val instanceof SelectInterface) {
                $selects[":{$key}"] = $val;
            } else {
                $this->bindValue($key, $val);
            }
        }

        foreach ($selects as $key => $select) {
            $selects[$key] = $select->getStatement();
            $this->bind_values = array_merge(
                $this->bind_values,
                $select->getBindValues()
            );
        }

        $cond = strtr($cond, $selects);
        return $cond;
    }

    /**
     *
     * 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;
    }
}


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\SelectInterface;
12		use Aura\SqlQuery\Common\QuoterInterface;
13
14		/**
15		*
16		* Abstract query object.
17		*
18		* @package Aura.SqlQuery
19		*
20		*/
21		abstract class AbstractQuery
22		{
23		/**
24		*
25		* Data to be bound to the query.
26		*
27		* @var array
28		*
29		*/
30		protected $bind_values = array();
31
32		/**
33		*
34		* The list of WHERE conditions.
35		*
36		* @var array
37		*
38		*/
39		protected $where = array();
40
41		/**
42		*
43		* ORDER BY these columns.
44		*
45		* @var array
46		*
47		*/
48		protected $order_by = array();
49
50		/**
51		*
52		* The list of flags.
53		*
54		* @var array
55		*
56		*/
57		protected $flags = array();
58
59		/**
60		*
61		* A helper for quoting identifier names.
62		*
63		* @var Quoter
64		*
65		*/
66		protected $quoter;
67
68		/**
69		*
70		* Constructor.
71		*
72		* @param Quoter $quoter A helper for quoting identifier names.
73		*
74		*/
75	407	public function __construct(QuoterInterface $quoter, $builder)
76		{
77	407	$this->quoter = $quoter;
		0 ignored issues – show Documentation Bug introduced 2017-03-19 15:33 UTC by Report Bug Copy Issue Report It seems like `$quoter` of type `object<Aura\SqlQuery\Common\QuoterInterface>` is incompatible with the declared type `object<Aura\SqlQuery\Quoter>` of property `$quoter`. 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...
78	407	$this->builder = $builder;
		0 ignored issues – show Bug introduced 2017-03-17 16:53 UTC by Report Bug Copy Issue Report The property `builder` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
79	407	}
80
81		/**
82		*
83		* Returns this query object as an SQL statement string.
84		*
85		* @return string
86		*
87		*/
88	243	public function __toString()
89		{
90	243	return $this->getStatement();
91		}
92
93		/**
94		*
95		* Returns this query object as an SQL statement string.
96		*
97		* @return string
98		*
99		*/
100	69	public function getStatement()
101		{
102	69	return $this->build();
103		}
104
105		/**
106		*
107		* Builds this query object into a string.
108		*
109		* @return string
110		*
111		*/
112		abstract protected function build();
113
114		/**
115		*
116		* Returns the prefix to use when quoting identifier names.
117		*
118		* @return string
119		*
120		*/
121	257	public function getQuoteNamePrefix()
122		{
123	257	return $this->quoter->getQuoteNamePrefix();
124		}
125
126		/**
127		*
128		* Returns the suffix to use when quoting identifier names.
129		*
130		* @return string
131		*
132		*/
133	257	public function getQuoteNameSuffix()
134		{
135	257	return $this->quoter->getQuoteNameSuffix();
136		}
137
138		/**
139		*
140		* Binds multiple values to placeholders; merges with existing values.
141		*
142		* @param array $bind_values Values to bind to placeholders.
143		*
144		* @return $this
145		*
146		*/
147	31	public function bindValues(array $bind_values)
148		{
149		// array_merge() renumbers integer keys, which is bad for
150		// question-mark placeholders
151	31	foreach ($bind_values as $key => $val) {
152	31	$this->bindValue($key, $val);
153	31	}
154	31	return $this;
155		}
156
157		/**
158		*
159		* Binds a single value to the query.
160		*
161		* @param string $name The placeholder name or number.
162		*
163		* @param mixed $value The value to bind to the placeholder.
164		*
165		* @return $this
166		*
167		*/
168	136	public function bindValue($name, $value)
169		{
170	136	$this->bind_values[$name] = $value;
171	136	return $this;
172		}
173
174		/**
175		*
176		* Gets the values to bind to placeholders.
177		*
178		* @return array
179		*
180		*/
181	126	public function getBindValues()
182		{
183	126	return $this->bind_values;
184		}
185
186		/**
187		*
188		* Reset all values bound to named placeholders.
189		*
190		* @return $this
191		*
192		*/
193	15	public function resetBindValues()
194		{
195	15	$this->bind_values = array();
196	15	return $this;
197		}
198
199		/**
200		*
201		* Sets or unsets specified flag.
202		*
203		* @param string $flag Flag to set or unset
204		*
205		* @param bool $enable Flag status - enabled or not (default true)
206		*
207		* @return null
208		*
209		*/
210	43	protected function setFlag($flag, $enable = true)
211		{
212	43	if ($enable) {
213	43	$this->flags[$flag] = true;
214	43	} else {
215	5	unset($this->flags[$flag]);
216		}
217	43	}
218
219		/**
220		*
221		* Returns true if the specified flag was enabled by setFlag().
222		*
223		* @param string $flag Flag to check
224		*
225		* @return bool
226		*
227		*/
228	10	protected function hasFlag($flag)
229		{
230	10	return isset($this->flags[$flag]);
231		}
232
233		/**
234		*
235		* Reset all query flags.
236		*
237		* @return $this
238		*
239		*/
240	20	public function resetFlags()
241		{
242	20	$this->flags = array();
243	20	return $this;
244		}
245
246		/**
247		*
248		* Adds conditions and binds values to a clause.
249		*
250		* @param string $clause The clause to work with, typically 'where' or
251		* 'having'.
252		*
253		* @param string $andor Add the condition using this operator, typically
254		* 'AND' or 'OR'.
255		*
256		* @param string $cond The WHERE condition.
257		*
258		* @param array $bind arguments to bind to placeholders
259		*
260		* @return null
261		*
262		*/
263	70	protected function addClauseCondWithBind($clause, $andor, $cond, $bind)
264		{
265	70	$cond = $this->quoter->quoteNamesIn($cond);
266	70	$cond = $this->rebuildCondAndBindValues($cond, $bind);
267
268	70	$clause =& $this->$clause;
269	70	if ($clause) {
270	49	$clause[] = "$andor $cond";
271	49	} else {
272	70	$clause[] = $cond;
273		}
274	70	}
275
276		/**
277		*
278		* Rebuilds a condition string, replacing sequential placeholders with
279		* named placeholders, and binding the sequential values to the named
280		* placeholders.
281		*
282		* @param string $cond The condition with sequential placeholders.
283		*
284		* @param array $bind_values The values to bind to the sequential
285		* placeholders under their named versions.
286		*
287		* @return string The rebuilt condition string.
288		*
289		*/
290	120	protected function rebuildCondAndBindValues($cond, array $bind_values)
291		{
292	120	$selects = [];
293
294	120	foreach ($bind_values as $key => $val) {
295	80	if ($val instanceof SelectInterface) {
296	10	$selects[":{$key}"] = $val;
297	10	} else {
298	75	$this->bindValue($key, $val);
299		}
300	120	}
301
302	120	foreach ($selects as $key => $select) {
303	10	$selects[$key] = $select->getStatement();
304	10	$this->bind_values = array_merge(
305	10	$this->bind_values,
306	10	$select->getBindValues()
307	10	);
308	120	}
309
310	120	$cond = strtr($cond, $selects);
311	120	return $cond;
312		}
313
314		/**
315		*
316		* Adds a column order to the query.
317		*
318		* @param array $spec The columns and direction to order by.
319		*
320		* @return $this
321		*
322		*/
323	9	protected function addOrderBy(array $spec)
324		{
325	9	foreach ($spec as $col) {
326	9	$this->order_by[] = $this->quoter->quoteNamesIn($col);
327	9	}
328	9	return $this;
329		}
330		}
331

auraphp / Aura.SqlQuery

Pull Request — 3.x (#134)

AbstractQuery::__toString() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like