Where::createWhereIn() - Code Metrics - Inspection of "enable telemetry extension on CI builds" - pomm-project/Foundation - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 2.0 (#75)

by Julien

created 2016-07-01 16:51 UTC

Where::createWhereIn() A

↳ Parent: Where

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	1

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

<?php
/*
 * This file is part of the PommProject/Foundation package.
 *
 * (c) 2011 - 2015 Grégoire HUBERT <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace PommProject\Foundation;

/**
 * Where
 *
 * This class represents a WHERE clause of a SQL statement. It deals with AND &
 * OR operator you can add using handy methods. This allows you to build
 * queries dynamically.
 *
 * @package   Foundation
 * @copyright 2014 - 2015 Grégoire HUBERT
 * @author    Grégoire HUBERT <[email protected]>
 * @license   X11 {@link http://opensource.org/licenses/mit-license.php}
 */
class Where
{
    public $stack = [];
    public $element;
    public $values = [];
    public $operator;

    /**
     * create
     *
     * A constructor you can chain from.
     *
     * @static
     * @access public
     * @param  string $element
     * @param  array  $values
     * @return Where
     */
    public static function create($element = null, array $values = [])
    {
        return new self($element, $values);
    }

    /**
     * createWhereIn
     *
     * Create an escaped IN clause.
     *
     * @access public
     * @param  string $element
     * @param  array  $values
     * @return Where
     */
    public static function createWhereIn($element, array $values)
    {
        return self::createGroupCondition($element, 'IN', $values);
    }

    /**
     * createWhereNotIn
     *
     * Create an escaped NOT IN clause.
     *
     * @access public
     * @param  string $element
     * @param  array $values
     * @return Where
     */
    public static function createWhereNotIn($element, array $values)
    {
        return self::createGroupCondition($element, 'NOT IN', $values);
    }

    /**
     * createGroupCondition
     *
     * Create a Where instance with multiple escaped parameters. This is mainly
     * useful for IN or NOT IN clauses.
     *
     * @access public
     * @param  string $element
     * @param  string $operation
     * @param  array  $values
     * @return Where
     */
    public static function createGroupCondition($element, $operation, array $values)
    {
        return new self(
            sprintf(
                "%s %s (%s)",
                $element,
                $operation,
                join(", ", static::escapeSet($values))
            ),
            static::extractValues($values)
        );
    }

    /**
     * extractValues
     *
     * Extract values with consistent keys.
     *
     * @access protected
     * @param  array $values
     * @return array
     */
    protected static function extractValues(array $values)
    {
        $array = [];

        foreach (new \RecursiveIteratorIterator(new \RecursiveArrayIterator($values)) as $value) {
            $array[] = $value;
        }

        return $array;
    }

    /**
     * escapeSet
     *
     * Create an array of escaped strings from a value set.
     *
     * @access protected
     * @param  array $values
     * @return array
     */
    protected static function escapeSet(array $values)
    {
        $escaped_values = [];

        foreach ($values as $value) {
            if (is_array($value)) {
                $escaped_values[] =
                    sprintf("(%s)", join(', ', static::escapeSet($value)));
            } else {
                $escaped_values[] = '$*';
            }
        }

        return $escaped_values;
    }

    /**
     * __construct
     *
     * @access public
     * @param string $element (optional)
     * @param array  $values  (optional)
     */
    public function __construct($element = null, array $values = [])
    {
        if ($element !== null) {
            $this->element = $element;
            $this->values = $values;
        }
    }

    /**
     * setOperator
     *
     * is it an AND or an OR ?
     * or something else.
     * XOR can be expressed as "A = !B"
     *
     * @access public
     * @param  string $operator
     * @return Where
     */
    public function setOperator($operator)
    {
        $this->operator = $operator;

        return $this;
    }

    /**
     * isEmpty
     *
     * is it a fresh brand new object ?
     *
     * @access public
     * @return boolean
     */
    public function isEmpty()
    {
        return (bool) ($this->element === null && count($this->stack) == 0);
    }

    /**
     * transmute
     *
     * Absorbing another Where instance.
     *
     * @access private
     * @param  Where $where
     * @return Where $this
     */
    private function transmute(Where $where)
    {
        $this->stack    = $where->stack;
        $this->element  = $where->element;
        $this->operator = $where->operator;
        $this->values   = $where->values;
    }

    /**
     * addWhere
     *
     * You can add a new WHERE clause with your own operator.
     *
     * @access public
     * @param  mixed  $element
     * @param  array  $values
     * @param  string $operator
     * @return Where
     */
    public function addWhere($element, array $values, $operator)
    {
        if (!$element instanceof Where) {
            $element = new self($element, $values);
        }

        if ($element->isEmpty()) {
            return $this;
        }

        if ($this->isEmpty()) {
            $this->transmute($element);

            return $this;
        }

        if ($this->hasElement()) {
            $this->stack = [new self($this->getElement(), $this->values), $element];
            $this->element = null;
            $this->values = [];
        } else {
            if ($this->operator == $operator) {
                $this->stack[] = $element;
            } else {
                $this->stack = [
                    self::create()
                        ->setStack($this->stack)
                        ->setOperator($this->operator),
                    $element
                ];
            }
        }

        $this->operator = $operator;

        return $this;
    }

    /**
     * andWhere
     *
     * Or use a ready to use AND where clause.
     *
     * @access public
     * @param  mixed $element
     * @param  array $values
     * @return Where
     */
    public function andWhere($element, array $values = [])
    {
        return $this->addWhere($element, $values, 'AND');
    }

    /**
     * orWhere
     *
     * @access public
     * @param  mixed $element
     * @param  array $values
     * @return Where
     */
    public function orWhere($element, array $values = [])
    {
        return $this->addWhere($element, $values, 'OR');
    }

    /**
     * setStack
     *
     * @access public
     * @param  array $stack
     * @return Where
     */
    public function setStack(array $stack)
    {
        $this->stack = $stack;

        return $this;
    }

    /**
     * __toString
     *
     * where your SQL statement is built.
     *
     * @access public
     * @return string
     */
    public function __toString()
    {
        return $this->isEmpty() ? 'true' : $this->parse();
    }

    /**
     * hasElement
     *
     * @access public
     * @return boolean
     */
    public function hasElement()
    {
        return $this->element !== null;
    }

    /**
     * getElement
     *
     * @access public
     * @return string
     */
    public function getElement()
    {
        return $this->element;
    }

    /**
     * parse
     *
     * @access protected
     * @return string
     */
    protected function parse()
    {
        if ($this->hasElement()) {
            return $this->getElement();
        }

        $stack = [];
        foreach ($this->stack as $offset => $where) {
            $stack[$offset] = $where->parse();
        }

        return sprintf('(%s)', join(sprintf(' %s ', $this->operator), $stack));
    }

    /**
     * getValues
     *
     * Get all the values back for the prepared statement.
     *
     * @access public
     * @return array
     */
    public function getValues()
    {
        if ($this->isEmpty()) {
            return [];
        }

        if ($this->hasElement()) {
            return $this->values;
        }

        $values = [];

        foreach ($this->stack as $where) {
            $values[] = $where->getValues();
        }

        return call_user_func_array('array_merge', $values);
    }
}


1			<?php
2			/*
3			* This file is part of the PommProject/Foundation package.
4			*
5			* (c) 2011 - 2015 Grégoire HUBERT <[email protected]>
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10			namespace PommProject\Foundation;
11
12			/**
13			* Where
14			*
15			* This class represents a WHERE clause of a SQL statement. It deals with AND &
16			* OR operator you can add using handy methods. This allows you to build
17			* queries dynamically.
18			*
19			* @package Foundation
20			* @copyright 2014 - 2015 Grégoire HUBERT
21			* @author Grégoire HUBERT <[email protected]>
22			* @license X11 {@link http://opensource.org/licenses/mit-license.php}
23			*/
24			class Where
25			{
26			public $stack = [];
27			public $element;
28			public $values = [];
29			public $operator;
30
31			/**
32			* create
33			*
34			* A constructor you can chain from.
35			*
36			* @static
37			* @access public
38			* @param string $element
39			* @param array $values
40			* @return Where
41			*/
42			public static function create($element = null, array $values = [])
43			{
44			return new self($element, $values);
45			}
46
47			/**
48			* createWhereIn
49			*
50			* Create an escaped IN clause.
51			*
52			* @access public
53			* @param string $element
54			* @param array $values
55			* @return Where
56			*/
57			public static function createWhereIn($element, array $values)
58			{
59			return self::createGroupCondition($element, 'IN', $values);
60			}
61
62			/**
63			* createWhereNotIn
64			*
65			* Create an escaped NOT IN clause.
66			*
67			* @access public
68			* @param string $element
69			* @param array $values
70			* @return Where
71			*/
72			public static function createWhereNotIn($element, array $values)
73			{
74			return self::createGroupCondition($element, 'NOT IN', $values);
75			}
76
77			/**
78			* createGroupCondition
79			*
80			* Create a Where instance with multiple escaped parameters. This is mainly
81			* useful for IN or NOT IN clauses.
82			*
83			* @access public
84			* @param string $element
85			* @param string $operation
86			* @param array $values
87			* @return Where
88			*/
89			public static function createGroupCondition($element, $operation, array $values)
90			{
91			return new self(
92			sprintf(
93			"%s %s (%s)",
94			$element,
95			$operation,
96			join(", ", static::escapeSet($values))
97			),
98			static::extractValues($values)
99			);
100			}
101
102			/**
103			* extractValues
104			*
105			* Extract values with consistent keys.
106			*
107			* @access protected
108			* @param array $values
109			* @return array
110			*/
111			protected static function extractValues(array $values)
112			{
113			$array = [];
114
115			foreach (new \RecursiveIteratorIterator(new \RecursiveArrayIterator($values)) as $value) {
116			$array[] = $value;
117			}
118
119			return $array;
120			}
121
122			/**
123			* escapeSet
124			*
125			* Create an array of escaped strings from a value set.
126			*
127			* @access protected
128			* @param array $values
129			* @return array
130			*/
131			protected static function escapeSet(array $values)
132			{
133			$escaped_values = [];
134
135			foreach ($values as $value) {
136			if (is_array($value)) {
137			$escaped_values[] =
138			sprintf("(%s)", join(', ', static::escapeSet($value)));
139			} else {
140			$escaped_values[] = '$*';
141			}
142			}
143
144			return $escaped_values;
145			}
146
147			/**
148			* __construct
149			*
150			* @access public
151			* @param string $element (optional)
152			* @param array $values (optional)
153			*/
154			public function __construct($element = null, array $values = [])
155			{
156			if ($element !== null) {
157			$this->element = $element;
158			$this->values = $values;
159			}
160			}
161
162			/**
163			* setOperator
164			*
165			* is it an AND or an OR ?
166			* or something else.
167			* XOR can be expressed as "A = !B"
168			*
169			* @access public
170			* @param string $operator
171			* @return Where
172			*/
173			public function setOperator($operator)
174			{
175			$this->operator = $operator;
176
177			return $this;
178			}
179
180			/**
181			* isEmpty
182			*
183			* is it a fresh brand new object ?
184			*
185			* @access public
186			* @return boolean
187			*/
188			public function isEmpty()
189			{
190			return (bool) ($this->element === null && count($this->stack) == 0);
191			}
192
193			/**
194			* transmute
195			*
196			* Absorbing another Where instance.
197			*
198			* @access private
199			* @param Where $where
200			* @return Where $this
201			*/
202			private function transmute(Where $where)
203			{
204			$this->stack = $where->stack;
205			$this->element = $where->element;
206			$this->operator = $where->operator;
207			$this->values = $where->values;
208			}
209
210			/**
211			* addWhere
212			*
213			* You can add a new WHERE clause with your own operator.
214			*
215			* @access public
216			* @param mixed $element
217			* @param array $values
218			* @param string $operator
219			* @return Where
220			*/
221			public function addWhere($element, array $values, $operator)
222			{
223			if (!$element instanceof Where) {
224			$element = new self($element, $values);
225			}
226
227			if ($element->isEmpty()) {
228			return $this;
229			}
230
231			if ($this->isEmpty()) {
232			$this->transmute($element);
233
234			return $this;
235			}
236
237			if ($this->hasElement()) {
238			$this->stack = [new self($this->getElement(), $this->values), $element];
239			$this->element = null;
240			$this->values = [];
241			} else {
242			if ($this->operator == $operator) {
243			$this->stack[] = $element;
244			} else {
245			$this->stack = [
246			self::create()
247			->setStack($this->stack)
248			->setOperator($this->operator),
249			$element
250			];
251			}
252			}
253
254			$this->operator = $operator;
255
256			return $this;
257			}
258
259			/**
260			* andWhere
261			*
262			* Or use a ready to use AND where clause.
263			*
264			* @access public
265			* @param mixed $element
266			* @param array $values
267			* @return Where
268			*/
269			public function andWhere($element, array $values = [])
270			{
271			return $this->addWhere($element, $values, 'AND');
272			}
273
274			/**
275			* orWhere
276			*
277			* @access public
278			* @param mixed $element
279			* @param array $values
280			* @return Where
281			*/
282			public function orWhere($element, array $values = [])
283			{
284			return $this->addWhere($element, $values, 'OR');
285			}
286
287			/**
288			* setStack
289			*
290			* @access public
291			* @param array $stack
292			* @return Where
293			*/
294			public function setStack(array $stack)
295			{
296			$this->stack = $stack;
297
298			return $this;
299			}
300
301			/**
302			* __toString
303			*
304			* where your SQL statement is built.
305			*
306			* @access public
307			* @return string
308			*/
309			public function __toString()
310			{
311			return $this->isEmpty() ? 'true' : $this->parse();
312			}
313
314			/**
315			* hasElement
316			*
317			* @access public
318			* @return boolean
319			*/
320			public function hasElement()
321			{
322			return $this->element !== null;
323			}
324
325			/**
326			* getElement
327			*
328			* @access public
329			* @return string
330			*/
331			public function getElement()
332			{
333			return $this->element;
334			}
335
336			/**
337			* parse
338			*
339			* @access protected
340			* @return string
341			*/
342			protected function parse()
343			{
344			if ($this->hasElement()) {
345			return $this->getElement();
346			}
347
348			$stack = [];
349			foreach ($this->stack as $offset => $where) {
350			$stack[$offset] = $where->parse();
351			}
352
353			return sprintf('(%s)', join(sprintf(' %s ', $this->operator), $stack));
354			}
355
356			/**
357			* getValues
358			*
359			* Get all the values back for the prepared statement.
360			*
361			* @access public
362			* @return array
363			*/
364			public function getValues()
365			{
366			if ($this->isEmpty()) {
367			return [];
368			}
369
370			if ($this->hasElement()) {
371			return $this->values;
372			}
373
374			$values = [];
375
376			foreach ($this->stack as $where) {
377			$values[] = $where->getValues();
378			}
379
380			return call_user_func_array('array_merge', $values);
381			}
382			}
383

pomm-project / Foundation

Pull Request — 2.0 (#75)

Where::createWhereIn() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like