Criteria::render() - Code Metrics - Inspection of "fix: https://github.com/XOOPS/XoopsCore25/issues/1..." - XOOPS/XoopsCore25 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#1471)

unknown

created 2024-06-17 12:50 UTC

Criteria::render() C

↳ Parent: Criteria

Complexity

Conditions	12
Paths	96

Size

Total Lines	25
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	12
eloc	17
nc	96
nop	0
dl	0
loc	25
rs	6.9666
c	0
b	0
f	0

How to fix Complexity

<?php
/**
 * XOOPS Criteria parser for database query
 *
 * You may not change or alter any portion of this comment or credits
 * of supporting developers from this source code or any supporting source code
 * which is considered copyrighted (c) material of the original comment or credit authors.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * @copyright       (c) 2000-2016 XOOPS Project (www.xoops.org)
 * @license             GNU GPL 2 (https://www.gnu.org/licenses/gpl-2.0.html)
 * @package             kernel
 * @subpackage          database
 * @since               2.0.0
 * @author              Kazumi Ono <[email protected]>
 * @author              Nathan Dial
 * @author              Taiwen Jiang <[email protected]>
 */
defined('XOOPS_ROOT_PATH') || exit('Restricted access');

/**
 * A criteria (grammar?) for a database query.
 *
 * Abstract base class should never be instantiated directly.
 *
 * @abstract
 */
class CriteriaElement
{
    /**
     * Sort order
     *
     * @var string
     */
    public $order = 'ASC';

    /**
     *
     * @var string
     */
    public $sort = '';

    /**
     * Number of records to retrieve
     *
     * @var int
     */
    public $limit = 0;

    /**
     * Offset of first record
     *
     * @var int
     */
    public $start = 0;

    /**
     *
     * @var string
     */
    public $groupby = '';

    /**
     * Constructor
     */
    public function __construct()
    {
    }

    /**
     * Render the criteria element
     * @return string
     */
    public function render()
    {
    }

    /**
     *
     * @param string $sort
     */
    public function setSort($sort)
    {
        $this->sort = $sort;
    }

    /**
     *
     * @return string
     */
    public function getSort()
    {
        return $this->sort;
    }

    /**
     *
     * @param string $order
     */
    public function setOrder($order)
    {
        if ('DESC' === strtoupper($order)) {
            $this->order = 'DESC';
        }
    }

    /**
     *
     * @return string
     */
    public function getOrder()
    {
        return $this->order;
    }

    /**
     *
     * @param int $limit
     */
    public function setLimit($limit = 0)
    {
        $this->limit = (int)$limit;
    }

    /**
     *
     * @return int
     */
    public function getLimit()
    {
        return $this->limit;
    }

    /**
     *
     * @param int $start
     */
    public function setStart($start = 0)
    {
        $this->start = (int)$start;
    }

    /**
     *
     * @return int
     */
    public function getStart()
    {
        return $this->start;
    }

    /**
     *
     * @param string $group
     */
    public function setGroupBy($group)
    {
        $this->groupby = $group;
    }

    /**
     *
     * @return string
     */
    public function getGroupby()
    {
        return $this->groupby ? " GROUP BY {$this->groupby}" : '';
    }
    /**
     * *#@-
     */
}

/**
 * Collection of multiple {@link CriteriaElement}s
 *
 */
class CriteriaCompo extends CriteriaElement
{
    /**
     * The elements of the collection
     *
     * @var array Array of {@link CriteriaElement} objects
     */
    public $criteriaElements = array();

    /**
     * Conditions
     *
     * @var array
     */
    public $conditions = array();

    /**
     * Constructor
     *
     * @param CriteriaElement|null $ele
     * @param string $condition
     */
    public function __construct(CriteriaElement $ele = null, $condition = 'AND')
    {
        if (isset($ele)) {
            $this->add($ele, $condition);
        }
    }

    /**
     * Add an element
     *
     * @param CriteriaElement|object $criteriaElement
     * @param string                 $condition
     * @return object reference to this collection
     */
    public function &add(CriteriaElement $criteriaElement, $condition = 'AND')
    {
        if (is_object($criteriaElement)) {
            $this->criteriaElements[] =& $criteriaElement;
            $this->conditions[]       = $condition;
        }

        return $this;
    }

    /**
     * Make the criteria into a query string
     *
     * @return string
     */
    public function render()
    {
        $ret   = '';
        $count = count($this->criteriaElements);
        if ($count > 0) {
            $render_string = $this->criteriaElements[0]->render();
            for ($i = 1; $i < $count; ++$i) {
                if (!$render = $this->criteriaElements[$i]->render()) {
                    continue;
                }
                $render_string .= (empty($render_string) ? '' : ' ' . $this->conditions[$i] . ' ') . $render;
            }
            $ret = empty($render_string) ? '' : "({$render_string})";
        }

        return $ret;
    }

    /**
     * Make the criteria into a SQL "WHERE" clause
     *
     * @return string
     */
    public function renderWhere()
    {
        $ret = $this->render();
        $ret = ($ret != '') ? 'WHERE ' . $ret : $ret;

        return $ret;
    }

    /**
     * Generate an LDAP filter from criteria
     *
     * @return string
     * @author Nathan Dial [email protected]
     */
    public function renderLdap()
    {
        $retval = '';
        $count  = count($this->criteriaElements);
        if ($count > 0) {
            $retval = $this->criteriaElements[0]->renderLdap();
            for ($i = 1; $i < $count; ++$i) {
                $cond   = strtoupper($this->conditions[$i]);
                $op     = ($cond === 'OR') ? '|' : '&';
                $retval = "({$op}{$retval}" . $this->criteriaElements[$i]->renderLdap() . ')';
            }
        }

        return $retval;
    }
}

/**
 * A single criteria
 *
 */
class Criteria extends CriteriaElement
{
    /**
     *
     * @var string
     */
    public $prefix;
    public $function;
    public $column;
    public $operator;
    public $value;
    protected $allowEmptyValue = false;

    /**
     * Constructor
     *
     * @param string $column
     * @param string $value
     * @param string $operator
     * @param string $prefix
     * @param string $function
     * @param boolean $allowEmptyValue
     */
    public function __construct($column, $value = '', $operator = '=', $prefix = '', $function = '', $allowEmptyValue = false)
    {
        $this->prefix   = $prefix;
        $this->function = $function;
        $this->column   = $column;
        $this->value    = $value;
        $this->operator = $operator;
        $this->allowEmptyValue = $allowEmptyValue;

        /**
         * A common custom in some older programs was to use "new Criteria(1, '1')" to
         * create an always true clause, WHERE 1 = "1"
         *
         * This is no longer needed and now no longer works. Instead, use "new Criteria('')"
         * or "new CriteriaCompo()", either of which will produce no WHERE clause.
         *
         * The following is a temporary workaround for the old technique
         */
        if ((int) $column === 1 && (int) $value === 1 && $operator === '=') {
            $this->column = '';
            $this->value  = '';
        }
    }

    /**
     * Make a sql condition string
     *
     * @return string
     */
    public function render()
    {
        $backtick = (false === strpos($this->column, '.')) ? '`' : '';
        $backtick = (false !== strpos($this->column, '(')) ? '' : $backtick;
        $clause = (!empty($this->prefix) ? "{$this->prefix}." : '') . $backtick . $this->column . $backtick;
        if (!empty($this->function)) {
            $clause = sprintf($this->function, $clause);
        }
        if (in_array(strtoupper($this->operator), array('IS NULL', 'IS NOT NULL'))) {
            $clause .= ' ' . $this->operator;
        } else {
            if ('' === ($value = trim((string)$this->value)) && !$this->allowEmptyValue) {
                return '';
            }
            if (!in_array(strtoupper($this->operator), array('IN', 'NOT IN'))) {
                if ((substr($value, 0, 1) !== '`') && (substr($value, -1) !== '`')) {
                    $value = "'{$value}'";
                } elseif (!preg_match('/^[a-zA-Z0-9_\.\-`]*$/', $value)) {
                    $value = '``';
                }
            }
            $clause .= " {$this->operator} {$value}";
        }

        return $clause;
    }

    /**
     * Generate an LDAP filter from criteria
     *
     * @return string
     * @author Nathan Dial [email protected], improved by Pierre-Eric MENUET [email protected]
     */
    public function renderLdap()
    {
        if ($this->operator === '>') {
            $this->operator = '>=';
        }
        if ($this->operator === '<') {
            $this->operator = '<=';
        }

        if ($this->operator === '!=' || $this->operator === '<>') {
            $operator = '=';
            $clause   = '(!(' . $this->column . $operator . $this->value . '))';
        } else {
            if ($this->operator === 'IN') {
                $newvalue = str_replace(array('(', ')'), '', $this->value);
                $tab      = explode(',', $newvalue);
                $clause = '';
                foreach ($tab as $uid) {
                    $clause .= "({$this->column}={$uid})";
                }
                $clause = '(|' . $clause . ')';
            } else {
                $clause = '(' . $this->column . $this->operator . $this->value . ')';
            }
        }

        return $clause;
    }

    /**
     * Make a SQL "WHERE" clause
     *
     * @return string
     */
    public function renderWhere()
    {
        $cond = $this->render();

        return empty($cond) ? '' : "WHERE {$cond}";
    }
}


1			<?php
2			/**
3			* XOOPS Criteria parser for database query
4			*
5			* You may not change or alter any portion of this comment or credits
6			* of supporting developers from this source code or any supporting source code
7			* which is considered copyrighted (c) material of the original comment or credit authors.
8			* This program is distributed in the hope that it will be useful,
9			* but WITHOUT ANY WARRANTY; without even the implied warranty of
10			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11			*
12			* @copyright (c) 2000-2016 XOOPS Project (www.xoops.org)
13			* @license GNU GPL 2 (https://www.gnu.org/licenses/gpl-2.0.html)
14			* @package kernel
15			* @subpackage database
16			* @since 2.0.0
17			* @author Kazumi Ono <[email protected]>
18			* @author Nathan Dial
19			* @author Taiwen Jiang <[email protected]>
20			*/
21			defined('XOOPS_ROOT_PATH') \|\| exit('Restricted access');
22
23			/**
24			* A criteria (grammar?) for a database query.
25			*
26			* Abstract base class should never be instantiated directly.
27			*
28			* @abstract
29			*/
30			class CriteriaElement
31			{
32			/**
33			* Sort order
34			*
35			* @var string
36			*/
37			public $order = 'ASC';
38
39			/**
40			*
41			* @var string
42			*/
43			public $sort = '';
44
45			/**
46			* Number of records to retrieve
47			*
48			* @var int
49			*/
50			public $limit = 0;
51
52			/**
53			* Offset of first record
54			*
55			* @var int
56			*/
57			public $start = 0;
58
59			/**
60			*
61			* @var string
62			*/
63			public $groupby = '';
64
65			/**
66			* Constructor
67			*/
68			public function __construct()
69			{
70			}
71
72			/**
73			* Render the criteria element
74			* @return string
75			*/
76			public function render()
77			{
78			}
79
80			/**
81			*
82			* @param string $sort
83			*/
84			public function setSort($sort)
85			{
86			$this->sort = $sort;
87			}
88
89			/**
90			*
91			* @return string
92			*/
93			public function getSort()
94			{
95			return $this->sort;
96			}
97
98			/**
99			*
100			* @param string $order
101			*/
102			public function setOrder($order)
103			{
104			if ('DESC' === strtoupper($order)) {
105			$this->order = 'DESC';
106			}
107			}
108
109			/**
110			*
111			* @return string
112			*/
113			public function getOrder()
114			{
115			return $this->order;
116			}
117
118			/**
119			*
120			* @param int $limit
121			*/
122			public function setLimit($limit = 0)
123			{
124			$this->limit = (int)$limit;
125			}
126
127			/**
128			*
129			* @return int
130			*/
131			public function getLimit()
132			{
133			return $this->limit;
134			}
135
136			/**
137			*
138			* @param int $start
139			*/
140			public function setStart($start = 0)
141			{
142			$this->start = (int)$start;
143			}
144
145			/**
146			*
147			* @return int
148			*/
149			public function getStart()
150			{
151			return $this->start;
152			}
153
154			/**
155			*
156			* @param string $group
157			*/
158			public function setGroupBy($group)
159			{
160			$this->groupby = $group;
161			}
162
163			/**
164			*
165			* @return string
166			*/
167			public function getGroupby()
168			{
169			return $this->groupby ? " GROUP BY {$this->groupby}" : '';
170			}
171			/**
172			* *#@-
173			*/
174			}
175
176			/**
177			* Collection of multiple {@link CriteriaElement}s
178			*
179			*/
180			class CriteriaCompo extends CriteriaElement
181			{
182			/**
183			* The elements of the collection
184			*
185			* @var array Array of {@link CriteriaElement} objects
186			*/
187			public $criteriaElements = array();
188
189			/**
190			* Conditions
191			*
192			* @var array
193			*/
194			public $conditions = array();
195
196			/**
197			* Constructor
198			*
199			* @param CriteriaElement\|null $ele
200			* @param string $condition
201			*/
202			public function __construct(CriteriaElement $ele = null, $condition = 'AND')
203			{
204			if (isset($ele)) {
205			$this->add($ele, $condition);
206			}
207			}
208
209			/**
210			* Add an element
211			*
212			* @param CriteriaElement\|object $criteriaElement
213			* @param string $condition
214			* @return object reference to this collection
215			*/
216			public function &add(CriteriaElement $criteriaElement, $condition = 'AND')
217			{
218			if (is_object($criteriaElement)) {
219			$this->criteriaElements[] =& $criteriaElement;
220			$this->conditions[] = $condition;
221			}
222
223			return $this;
224			}
225
226			/**
227			* Make the criteria into a query string
228			*
229			* @return string
230			*/
231			public function render()
232			{
233			$ret = '';
234			$count = count($this->criteriaElements);
235			if ($count > 0) {
236			$render_string = $this->criteriaElements[0]->render();
237			for ($i = 1; $i < $count; ++$i) {
238			if (!$render = $this->criteriaElements[$i]->render()) {
239			continue;
240			}
241			$render_string .= (empty($render_string) ? '' : ' ' . $this->conditions[$i] . ' ') . $render;
242			}
243			$ret = empty($render_string) ? '' : "({$render_string})";
244			}
245
246			return $ret;
247			}
248
249			/**
250			* Make the criteria into a SQL "WHERE" clause
251			*
252			* @return string
253			*/
254			public function renderWhere()
255			{
256			$ret = $this->render();
257			$ret = ($ret != '') ? 'WHERE ' . $ret : $ret;
258
259			return $ret;
260			}
261
262			/**
263			* Generate an LDAP filter from criteria
264			*
265			* @return string
266			* @author Nathan Dial [email protected]
267			*/
268			public function renderLdap()
269			{
270			$retval = '';
271			$count = count($this->criteriaElements);
272			if ($count > 0) {
273			$retval = $this->criteriaElements[0]->renderLdap();
274			for ($i = 1; $i < $count; ++$i) {
275			$cond = strtoupper($this->conditions[$i]);
276			$op = ($cond === 'OR') ? '\|' : '&';
277			$retval = "({$op}{$retval}" . $this->criteriaElements[$i]->renderLdap() . ')';
278			}
279			}
280
281			return $retval;
282			}
283			}
284
285			/**
286			* A single criteria
287			*
288			*/
289			class Criteria extends CriteriaElement
290			{
291			/**
292			*
293			* @var string
294			*/
295			public $prefix;
296			public $function;
297			public $column;
298			public $operator;
299			public $value;
300			protected $allowEmptyValue = false;
301
302			/**
303			* Constructor
304			*
305			* @param string $column
306			* @param string $value
307			* @param string $operator
308			* @param string $prefix
309			* @param string $function
310			* @param boolean $allowEmptyValue
311			*/
312			public function __construct($column, $value = '', $operator = '=', $prefix = '', $function = '', $allowEmptyValue = false)
313			{
314			$this->prefix = $prefix;
315			$this->function = $function;
316			$this->column = $column;
317			$this->value = $value;
318			$this->operator = $operator;
319			$this->allowEmptyValue = $allowEmptyValue;
320
321			/**
322			* A common custom in some older programs was to use "new Criteria(1, '1')" to
323			* create an always true clause, WHERE 1 = "1"
324			*
325			* This is no longer needed and now no longer works. Instead, use "new Criteria('')"
326			* or "new CriteriaCompo()", either of which will produce no WHERE clause.
327			*
328			* The following is a temporary workaround for the old technique
329			*/
330			if ((int) $column === 1 && (int) $value === 1 && $operator === '=') {
331			$this->column = '';
332			$this->value = '';
333			}
334			}
335
336			/**
337			* Make a sql condition string
338			*
339			* @return string
340			*/
341			public function render()
342			{
343			$backtick = (false === strpos($this->column, '.')) ? '`' : '';
344			$backtick = (false !== strpos($this->column, '(')) ? '' : $backtick;
345			$clause = (!empty($this->prefix) ? "{$this->prefix}." : '') . $backtick . $this->column . $backtick;
346			if (!empty($this->function)) {
347			$clause = sprintf($this->function, $clause);
348			}
349			if (in_array(strtoupper($this->operator), array('IS NULL', 'IS NOT NULL'))) {
350			$clause .= ' ' . $this->operator;
351			} else {
352			if ('' === ($value = trim((string)$this->value)) && !$this->allowEmptyValue) {
353			return '';
354			}
355			if (!in_array(strtoupper($this->operator), array('IN', 'NOT IN'))) {
356			if ((substr($value, 0, 1) !== '`') && (substr($value, -1) !== '`')) {
357			$value = "'{$value}'";
358			} elseif (!preg_match('/^[a-zA-Z0-9_\.\-`]*$/', $value)) {
359			$value = '``';
360			}
361			}
362			$clause .= " {$this->operator} {$value}";
363			}
364
365			return $clause;
366			}
367
368			/**
369			* Generate an LDAP filter from criteria
370			*
371			* @return string
372			* @author Nathan Dial [email protected], improved by Pierre-Eric MENUET [email protected]
373			*/
374			public function renderLdap()
375			{
376			if ($this->operator === '>') {
377			$this->operator = '>=';
378			}
379			if ($this->operator === '<') {
380			$this->operator = '<=';
381			}
382
383			if ($this->operator === '!=' \|\| $this->operator === '<>') {
384			$operator = '=';
385			$clause = '(!(' . $this->column . $operator . $this->value . '))';
386			} else {
387			if ($this->operator === 'IN') {
388			$newvalue = str_replace(array('(', ')'), '', $this->value);
389			$tab = explode(',', $newvalue);
390			$clause = '';
391			foreach ($tab as $uid) {
392			$clause .= "({$this->column}={$uid})";
393			}
394			$clause = '(\|' . $clause . ')';
395			} else {
396			$clause = '(' . $this->column . $this->operator . $this->value . ')';
397			}
398			}
399
400			return $clause;
401			}
402
403			/**
404			* Make a SQL "WHERE" clause
405			*
406			* @return string
407			*/
408			public function renderWhere()
409			{
410			$cond = $this->render();
411
412			return empty($cond) ? '' : "WHERE {$cond}";
413			}
414			}
415

XOOPS / XoopsCore25

Pull Request — master (#1471)

Criteria::render() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like