AbstractDmlQuery::hasCols() - Code Metrics - Inspection of "merge 2.x" - auraphp/Aura.SqlQuery - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — resets ( d2f77b...f5109b )

by Paul

created 2016-05-20 14:06 UTC

AbstractDmlQuery::hasCols() A

↳ Parent: AbstractDmlQuery

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	0	Features	1

Metric	Value
c	1
b	0
f	1
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;

/**
 *
 * Abstract query object for data manipulation (Insert, Update, and Delete).
 *
 * @package Aura.SqlQuery
 *
 */
abstract class AbstractDmlQuery extends AbstractQuery
{
    /**
     *
     * Column values for INSERT or UPDATE queries; the key is the column name and the
     * value is the column value.
     *
     * @param array
     *
     */
    protected $col_values;

    /**
     *
     * The columns to be returned.
     *
     * @var array
     *
     */
    protected $returning = array();

    /**
     *
     * Does the query have any columns in it?
     *
     * @return bool
     *
     */
    public function hasCols()
    {
        return (bool) $this->col_values;
    }

    /**
     *
     * Sets one column value placeholder; if an optional second parameter is
     * passed, that value is bound to the placeholder.
     *
     * @param string $col The column name.
     *
     * @return $this
     *
     */
    protected function addCol($col)
    {
        $key = $this->quoter->quoteName($col);
        $this->col_values[$key] = ":$col";
        $args = func_get_args();
        if (count($args) > 1) {
            $this->bindValue($col, $args[1]);
        }
        return $this;
    }

    /**
     *
     * Sets multiple column value placeholders. If an element is a key-value
     * pair, the key is treated as the column name and the value is bound to
     * that column.
     *
     * @param array $cols A list of column names, optionally as key-value
     * pairs where the key is a column name and the value is a bind value for
     * that column.
     *
     * @return $this
     *
     */
    protected function addCols(array $cols)
    {
        foreach ($cols as $key => $val) {
            if (is_int($key)) {
                // integer key means the value is the column name
                $this->addCol($val);
            } else {
                // the key is the column name and the value is a value to
                // be bound to that column
                $this->addCol($key, $val);
            }
        }
        return $this;
    }

    /**
     *
     * Sets a column value directly; the value will not be escaped, although
     * fully-qualified identifiers in the value will be quoted.
     *
     * @param string $col The column name.
     *
     * @param string $value The column value expression.
     *
     * @return $this
     *
     */
    protected function setCol($col, $value)
    {
        if ($value === null) {
            $value = 'NULL';
        }

        $key = $this->quoter->quoteName($col);
        $value = $this->quoter->quoteNamesIn($value);
        $this->col_values[$key] = $value;
        return $this;
    }

    /**
     *
     * Adds returning columns to the query.
     *
     * Multiple calls to returning() will append to the list of columns, not
     * overwrite the previous columns.
     *
     * @param array $cols The column(s) to add to the query.
     *
     * @return $this
     *
     */
    protected function addReturning(array $cols)
    {
        foreach ($cols as $col) {
            $this->returning[] = $this->quoter->quoteNamesIn($col);
        }
        return $this;
    }

    /**
     *
     * Builds the `RETURNING` clause of the statement.
     *
     * @return string
     *
     */
    protected function buildReturning()
    {
        if (! $this->returning) {

            return ''; // not applicable
        }

        return PHP_EOL . 'RETURNING' . $this->indentCsv($this->returning);
    }
}


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		/**
12		*
13		* Abstract query object for data manipulation (Insert, Update, and Delete).
14		*
15		* @package Aura.SqlQuery
16		*
17		*/
18		abstract class AbstractDmlQuery extends AbstractQuery
19		{
20		/**
21		*
22		* Column values for INSERT or UPDATE queries; the key is the column name and the
23		* value is the column value.
24		*
25		* @param array
26		*
27		*/
28		protected $col_values;
29
30		/**
31		*
32		* The columns to be returned.
33		*
34		* @var array
35		*
36		*/
37		protected $returning = array();
38
39		/**
40		*
41		* Does the query have any columns in it?
42		*
43		* @return bool
44		*
45		*/
46		public function hasCols()
47		{
48		return (bool) $this->col_values;
49		}
50
51		/**
52		*
53		* Sets one column value placeholder; if an optional second parameter is
54		* passed, that value is bound to the placeholder.
55		*
56		* @param string $col The column name.
57		*
58		* @return $this
59		*
60		*/
61	62	protected function addCol($col)
62		{
63	62	$key = $this->quoter->quoteName($col);
64	62	$this->col_values[$key] = ":$col";
65	62	$args = func_get_args();
66	62	if (count($args) > 1) {
67	36	$this->bindValue($col, $args[1]);
68		}
69	62	return $this;
70		}
71
72		/**
73		*
74		* Sets multiple column value placeholders. If an element is a key-value
75		* pair, the key is treated as the column name and the value is bound to
76		* that column.
77		*
78		* @param array $cols A list of column names, optionally as key-value
79		* pairs where the key is a column name and the value is a bind value for
80		* that column.
81		*
82		* @return $this
83		*
84		*/
85	61	protected function addCols(array $cols)
86		{
87	61	foreach ($cols as $key => $val) {
88	61	if (is_int($key)) {
89		// integer key means the value is the column name
90	31	$this->addCol($val);
91		} else {
92		// the key is the column name and the value is a value to
93		// be bound to that column
94	61	$this->addCol($key, $val);
95		}
96		}
97	61	return $this;
98		}
99
100		/**
101		*
102		* Sets a column value directly; the value will not be escaped, although
103		* fully-qualified identifiers in the value will be quoted.
104		*
105		* @param string $col The column name.
106		*
107		* @param string $value The column value expression.
108		*
109		* @return $this
110		*
111		*/
112	45	protected function setCol($col, $value)
113		{
114	45	if ($value === null) {
115	30	$value = 'NULL';
116		}
117
118	45	$key = $this->quoter->quoteName($col);
119	45	$value = $this->quoter->quoteNamesIn($value);
120	45	$this->col_values[$key] = $value;
121	45	return $this;
122		}
123
124		/**
125		*
126		* Adds returning columns to the query.
127		*
128		* Multiple calls to returning() will append to the list of columns, not
129		* overwrite the previous columns.
130		*
131		* @param array $cols The column(s) to add to the query.
132		*
133		* @return $this
134		*
135		*/
136	3	protected function addReturning(array $cols)
137		{
138	3	foreach ($cols as $col) {
139	3	$this->returning[] = $this->quoter->quoteNamesIn($col);
140		}
141	3	return $this;
142		}
143
144		/**
145		*
146		* Builds the `RETURNING` clause of the statement.
147		*
148		* @return string
149		*
150		*/
151	68	protected function buildReturning()
152		{
153	68	if (! $this->returning) {
		0 ignored issues – show Bug Best Practice introduced 2016-02-03 01:44 UTC by Report Bug Copy Issue Report The expression `$this->returning` 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...
154	65	return ''; // not applicable
155		}
156
157	3	return PHP_EOL . 'RETURNING' . $this->indentCsv($this->returning);
158		}
159		}
160

auraphp / Aura.SqlQuery

Push — resets ( d2f77b...f5109b )

AbstractDmlQuery::hasCols() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like