Criteria::renderLdap() - Code Metrics - Inspection of "Merge pull request #533 from geekwright/fa-step2" - XOOPS/XoopsCore - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e0f917...34b2b8 )

by Michael

created 2017-03-12 19:46 UTC

Criteria::renderLdap() C

↳ Parent: Criteria

Complexity

Conditions	7
Paths	12

Size

Total Lines	27
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	14.2702

Importance

Changes

Metric	Value
cc	7
eloc	19
nc	12
nop	0
dl	0
loc	27
rs	6.7272
c	0
b	0
f	0
ccs	8
cts	17
cp	0.4706
crap	14.2702

<?php
/*
 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.
*/

namespace Xoops\Core\Kernel;

use Doctrine\DBAL\Query\QueryBuilder;

/**
 * A single criteria for database query
 *
 * @category  Xoops\Core\Kernel\Criteria
 * @package   Xoops\Core\Kernel
 * @author    Kazumi Ono <[email protected]>
 * @author    Nathan Dial <[email protected]>
 * @author    Taiwen Jiang <[email protected]>
 * @copyright 2000-2013 XOOPS Project (http://xoops.org)
 * @license   GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @link      http://xoops.org
 * @since     2.0.0
 */
class Criteria extends CriteriaElement
{
    /**
     * @var string
     */
    public $prefix;

    /**
     * @var string
     */
    public $function;

    /**
     * @var string
     */
    public $column;

    /**
     * @var string
     */
    public $operator;

    /**
     * @var mixed
     */
    public $value;

    /**
     * Constructor
     *
     * @param string $column   column criteria applies to
     * @param string $value    value to compare to column
     * @param string $operator operator to apply to column
     * @param string $prefix   prefix to append to column
     * @param string $function sprintf string taking one string argument applied to column
     */
    public function __construct($column, $value = '', $operator = '=', $prefix = '', $function = '')
    {
        $this->prefix = $prefix;
        $this->function = $function;
        $this->column = $column;
        $this->value = $value;
        $this->operator = $operator;
    }

    /**
     * Make a sql condition string
     *
     * @return string
     */
    public function render()
    {
        $clause = (!empty($this->prefix) ? "{$this->prefix}." : "") . $this->column;
        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($this->value))) {
                return '';
            }
            if (!in_array(strtoupper($this->operator), array('IN', 'NOT IN'))) {
                if ((substr($value, 0, 1) !== '`') && (substr($value, -1) !== '`')) {
                    $value = "'{$value}'";
                } else {
                    if (!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()
    {
        $clause = '';
        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);
                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}";
    }

    /**
     * Render criteria as Doctrine QueryBuilder instructions
     *
     * @param QueryBuilder $qb        query builder instance
     * @param string       $whereMode how does this fit in the passed in QueryBuilder?
     *                                '' = as where,'and'= as andWhere, 'or' = as orWhere
     *
     * @return QueryBuilder query builder instance
     */
    public function renderQb(QueryBuilder $qb = null, $whereMode = '')
    {
        if ($qb==null) { // initialize query builder if not passed in
            $qb = \Xoops::getInstance()->db()->createXoopsQueryBuilder();
            $whereMode = ''; // first entry in new instance must be where
        }
        $expr = $this->buildExpressionQb($qb);

        switch (strtolower($whereMode)) {
            case 'and':
                $qb->andWhere($expr);
                break;
            case 'or':
                $qb->orWhere($expr);
                break;
            case '':
                $qb->where($expr);
                break;
        }

        if ($this->limit!=0 || $this->start!=0) {
            $qb->setFirstResult($this->start)
                ->setMaxResults($this->limit);
        }

        if (!empty($this->groupBy)) {
            $qb->groupBy($this->groupBy);
        }

        if (!empty($this->sort)) {
            $qb->orderBy($this->sort, $this->order);
        }

        return $qb;
    }

    /**
     * Build an expression to be included in a Doctrine QueryBuilder instance.
     *
     * This method will build an expression, adding any parameters to the query,
     * but the caller is responsible for adding the expression to the query, for
     * example as where() parameter. This allows the caller to handle all context,
     * such as parenthetical groupings.
     *
     * @param QueryBuilder $qb query builder instance
     *
     * @return string expression
     */
    public function buildExpressionQb(QueryBuilder $qb)
    {
        $eb = $qb->expr();

        $column = (empty($this->prefix) ? "" : $this->prefix.'.') . $this->column;

        // this should be done using portability functions
        if (!empty($this->function)) {
            $column = sprintf($this->function, $column);
        }

        $value=trim($this->value);

        $operator = strtolower($this->operator);
        $expr = '';

        // handle special case of value
        if (in_array($operator, array('is null', 'is not null', 'in', 'not in'))) {
            switch ($operator) {
                case 'is null':
                    $expr = $eb->isNull($column);
                    break;
                case 'is not null':
                    $expr = $eb->isNotNull($column);
                    break;
                case 'in':
                    if (!empty($value) && $value!=='()') {
                        $expr = $column . ' IN ' . $value;
                    } else {
                        // odd case of a null set - this won't match anything
                        $expr = $eb->neq($column, $column);
                    }
                    break;
                case 'not in':
                    if (!empty($value) && $value!=='()') {
                        $expr = $column . ' NOT IN ' . $value;
                    }
                    break;
            }
        } elseif (!empty($column)) { // no value is a nop (bug: this should be a valid value)
            $columnValue = $qb->createNamedParameter($value);
            switch ($operator) {
                case '=':
                case 'eq':
                    $expr = $eb->eq($column, $columnValue);
                    break;
                case '!=':
                case '<>':
                case 'neq':
                    $expr = $eb->neq($column, $columnValue);
                    break;
                case '<':
                case 'lt':
                    $expr = $eb->lt($column, $columnValue);
                    break;
                case '<=':
                case 'lte':
                    $expr = $eb->lte($column, $columnValue);
                    break;
                case '>':
                case 'gt':
                    $expr = $eb->gt($column, $columnValue);
                    break;
                case '>=':
                case 'gte':
                    $expr = $eb->gte($column, $columnValue);
                    break;
                case 'like':
                    $expr = $eb->like($column, $columnValue);
                    break;
                case 'not like':
                    $expr = $eb->notLike($column, $columnValue);
                    break;
                default:
                    $expr = $eb->comparison($column, strtoupper($operator), $columnValue);
                    break;
            }
        } else {
            $expr = '(1)';
        }
        return $expr;
    }
}


1			<?php
2			/*
3			You may not change or alter any portion of this comment or credits
4			of supporting developers from this source code or any supporting source code
5			which is considered copyrighted (c) material of the original comment or credit authors.
6
7			This program is distributed in the hope that it will be useful,
8			but WITHOUT ANY WARRANTY; without even the implied warranty of
9			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
10			*/
11
12			namespace Xoops\Core\Kernel;
13
14			use Doctrine\DBAL\Query\QueryBuilder;
15
16			/**
17			* A single criteria for database query
18			*
19			* @category Xoops\Core\Kernel\Criteria
20			* @package Xoops\Core\Kernel
21			* @author Kazumi Ono <[email protected]>
22			* @author Nathan Dial <[email protected]>
23			* @author Taiwen Jiang <[email protected]>
24			* @copyright 2000-2013 XOOPS Project (http://xoops.org)
25			* @license GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
26			* @link http://xoops.org
27			* @since 2.0.0
28			*/
29			class Criteria extends CriteriaElement
30			{
31			/**
32			* @var string
33			*/
34			public $prefix;
35
36			/**
37			* @var string
38			*/
39			public $function;
40
41			/**
42			* @var string
43			*/
44			public $column;
45
46			/**
47			* @var string
48			*/
49			public $operator;
50
51			/**
52			* @var mixed
53			*/
54			public $value;
55
56			/**
57			* Constructor
58			*
59			* @param string $column column criteria applies to
60			* @param string $value value to compare to column
61			* @param string $operator operator to apply to column
62			* @param string $prefix prefix to append to column
63			* @param string $function sprintf string taking one string argument applied to column
64			*/
65	58		public function __construct($column, $value = '', $operator = '=', $prefix = '', $function = '')
66			{
67	58		$this->prefix = $prefix;
68	58		$this->function = $function;
69	58		$this->column = $column;
70	58		$this->value = $value;
71	58		$this->operator = $operator;
72	58		}
73
74			/**
75			* Make a sql condition string
76			*
77			* @return string
78			*/
79	11		public function render()
80			{
81	11		$clause = (!empty($this->prefix) ? "{$this->prefix}." : "") . $this->column;
82	11		if (!empty($this->function)) {
83			$clause = sprintf($this->function, $clause);
84			}
85	11		if (in_array(strtoupper($this->operator), array('IS NULL', 'IS NOT NULL'))) {
86	2		$clause .= ' ' . $this->operator;
87			} else {
88	9		if ('' === ($value = trim($this->value))) {
89	3		return '';
90			}
91	6		if (!in_array(strtoupper($this->operator), array('IN', 'NOT IN'))) {
92	3		if ((substr($value, 0, 1) !== '`') && (substr($value, -1) !== '`')) {
93	3		$value = "'{$value}'";
94			} else {
95			if (!preg_match('/^[a-zA-Z0-9_\.\-`]*$/', $value)) {
96			$value = '``';
97			}
98			}
99			}
100	6		$clause .= " {$this->operator} {$value}";
101			}
102
103	8		return $clause;
104			}
105
106			/**
107			* Generate an LDAP filter from criteria
108			*
109			* @return string
110			* @author Nathan Dial [email protected], improved by Pierre-Eric MENUET [email protected]
111			*/
112	2		public function renderLdap()
113			{
114	2		$clause = '';
115	2		if ($this->operator === '>') {
116			$this->operator = '>=';
117			}
118	2		if ($this->operator === '<') {
119			$this->operator = '<=';
120			}
121
122	2		if ($this->operator === '!=' \|\| $this->operator === '<>') {
123			$operator = '=';
124			$clause = "(!(" . $this->column . $operator . $this->value . "))";
125			} else {
126	2		if ($this->operator === 'IN') {
127			$newvalue = str_replace(array('(', ')'), '', $this->value);
128			$tab = explode(',', $newvalue);
129			foreach ($tab as $uid) {
130			$clause .= "({$this->column}={$uid})";
131			}
132			$clause = '(\|' . $clause . ')';
133			} else {
134	2		$clause = "(" . $this->column . ' ' . $this->operator . ' ' . $this->value . ")";
135			}
136			}
137	2		return $clause;
138			}
139
140			/**
141			* Make a SQL "WHERE" clause
142			*
143			* @return string
144			*/
145	3		public function renderWhere()
146			{
147	3		$cond = $this->render();
148	3		return empty($cond) ? '' : "WHERE {$cond}";
149			}
150
151			/**
152			* Render criteria as Doctrine QueryBuilder instructions
153			*
154			* @param QueryBuilder $qb query builder instance
155			* @param string $whereMode how does this fit in the passed in QueryBuilder?
156			* '' = as where,'and'= as andWhere, 'or' = as orWhere
157			*
158			* @return QueryBuilder query builder instance
159			*/
160	26		public function renderQb(QueryBuilder $qb = null, $whereMode = '')
161			{
162	26		if ($qb==null) { // initialize query builder if not passed in
163	1		$qb = \Xoops::getInstance()->db()->createXoopsQueryBuilder();
164	1		$whereMode = ''; // first entry in new instance must be where
165			}
166	26		$expr = $this->buildExpressionQb($qb);
167
168	26	View Code Duplication	switch (strtolower($whereMode)) {
169	26		case 'and':
170			$qb->andWhere($expr);
171			break;
172	26		case 'or':
173			$qb->orWhere($expr);
174			break;
175	26		case '':
176	26		$qb->where($expr);
177	26		break;
178			}
179
180	26	View Code Duplication	if ($this->limit!=0 \|\| $this->start!=0) {
181			$qb->setFirstResult($this->start)
182			->setMaxResults($this->limit);
183			}
184
185	26		if (!empty($this->groupBy)) {
186			$qb->groupBy($this->groupBy);
187			}
188
189	26		if (!empty($this->sort)) {
190	6		$qb->orderBy($this->sort, $this->order);
191			}
192
193	26		return $qb;
194			}
195
196			/**
197			* Build an expression to be included in a Doctrine QueryBuilder instance.
198			*
199			* This method will build an expression, adding any parameters to the query,
200			* but the caller is responsible for adding the expression to the query, for
201			* example as where() parameter. This allows the caller to handle all context,
202			* such as parenthetical groupings.
203			*
204			* @param QueryBuilder $qb query builder instance
205			*
206			* @return string expression
207			*/
208	41		public function buildExpressionQb(QueryBuilder $qb)
209			{
210	41		$eb = $qb->expr();
211
212	41		$column = (empty($this->prefix) ? "" : $this->prefix.'.') . $this->column;
213
214			// this should be done using portability functions
215	41		if (!empty($this->function)) {
216			$column = sprintf($this->function, $column);
217			}
218
219	41		$value=trim($this->value);
220
221	41		$operator = strtolower($this->operator);
222	41		$expr = '';
223
224			// handle special case of value
225	41		if (in_array($operator, array('is null', 'is not null', 'in', 'not in'))) {
226			switch ($operator) {
227	2		case 'is null':
228			$expr = $eb->isNull($column);
229			break;
230	2		case 'is not null':
231			$expr = $eb->isNotNull($column);
232			break;
233	2		case 'in':
234			if (!empty($value) && $value!=='()') {
235			$expr = $column . ' IN ' . $value;
236			} else {
237			// odd case of a null set - this won't match anything
238			$expr = $eb->neq($column, $column);
239			}
240			break;
241	2		case 'not in':
242	2		if (!empty($value) && $value!=='()') {
243	2		$expr = $column . ' NOT IN ' . $value;
244			}
245	2		break;
246			}
247			} elseif (!empty($column)) { // no value is a nop (bug: this should be a valid value)
248	39		$columnValue = $qb->createNamedParameter($value);
249			switch ($operator) {
250	39		case '=':
251	5		case 'eq':
252	36		$expr = $eb->eq($column, $columnValue);
253	36		break;
254	5		case '!=':
255	3		case '<>':
256	3		case 'neq':
257	2		$expr = $eb->neq($column, $columnValue);
258	2		break;
259	3		case '<':
260	2		case 'lt':
261	1		$expr = $eb->lt($column, $columnValue);
262	1		break;
263	2		case '<=':
264	2		case 'lte':
265			$expr = $eb->lte($column, $columnValue);
266			break;
267	2		case '>':
268			case 'gt':
269	2		$expr = $eb->gt($column, $columnValue);
270	2		break;
271			case '>=':
272			case 'gte':
273			$expr = $eb->gte($column, $columnValue);
274			break;
275			case 'like':
276			$expr = $eb->like($column, $columnValue);
277			break;
278			case 'not like':
279			$expr = $eb->notLike($column, $columnValue);
280			break;
281			default:
282			$expr = $eb->comparison($column, strtoupper($operator), $columnValue);
283			break;
284			}
285			} else {
286			$expr = '(1)';
287			}
288	41		return $expr;
289			}
290			}
291

XOOPS / XoopsCore

Push — master ( e0f917...34b2b8 )

Criteria::renderLdap() C

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like