Criteria.php

Go to the documentation of this file.

<?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 Xoops\Core\Kernel\CriteriaElement;
use Doctrine\DBAL\Query\QueryBuilder;

class Criteria extends CriteriaElement
{
    public $prefix;

    public $function;

    public $column;

    public $operator;

    public $value;

    public function __construct($column, $value = '', $operator = '=', $prefix = '', $function = '')
    {
        $this->prefix = $prefix;
        $this->function = $function;
        $this->column = $column;
        $this->value = $value;
        $this->operator = $operator;
    }

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

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

    public function renderWhere()
    {
        $cond = $this->render();
        return empty($cond) ? '' : "WHERE {$cond}";
    }

    public function renderQb(QueryBuilder $qb = null, $whereMode = '')
    {
        if ($qb==null) { // initialize querybuilder if not passed in
            $qb = \Xoops::getInstance()->db()->createXoopsQueryBuilder();
            $whereMode = ''; // first entry in new instance must be where
        }
        $expr = $this->buildExpressionQb($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':
                    $expr = $column . ' IN ' . $value;
                    break;
                case 'not in':
                    $expr = $column . ' NOT IN '.$value;
                    break;
            }

        } elseif (empty($column)) { // no value is a nop (bug: this should be a valid value)
            $whereMode='none';
            $expr = '2=2';
        } else {
            $colvalue = $qb->createNamedParameter($value);
            switch ($operator) {
                case '=':
                case 'eq':
                    $expr = $eb->eq($column, $colvalue);
                    break;
                case '!=':
                case '<>':
                case 'neq':
                    $expr = $eb->neq($column, $colvalue);
                    break;
                case '<':
                case 'lt':
                    $expr = $eb->lt($column, $colvalue);
                    break;
                case '<=':
                case 'lte':
                    $expr = $eb->lte($column, $colvalue);
                    break;
                case '>':
                case 'gt':
                    $expr = $eb->gt($column, $colvalue);
                    break;
                case '>=':
                case 'gte':
                    $expr = $eb->gte($column, $colvalue);
                    break;
                case 'like':
                    $expr = $eb->like($column, $colvalue);
                    break;
                case 'not like':
                    $expr = $eb->notLike($column, $colvalue);
                    break;
                default:
                    $expr = $eb->comparison($column, strtoupper($operator), $colvalue);
                    break;
            }
        }
        */

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

    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)
            $colvalue = $qb->createNamedParameter($value);
            switch ($operator) {
                case '=':
                case 'eq':
                    $expr = $eb->eq($column, $colvalue);
                    break;
                case '!=':
                case '<>':
                case 'neq':
                    $expr = $eb->neq($column, $colvalue);
                    break;
                case '<':
                case 'lt':
                    $expr = $eb->lt($column, $colvalue);
                    break;
                case '<=':
                case 'lte':
                    $expr = $eb->lte($column, $colvalue);
                    break;
                case '>':
                case 'gt':
                    $expr = $eb->gt($column, $colvalue);
                    break;
                case '>=':
                case 'gte':
                    $expr = $eb->gte($column, $colvalue);
                    break;
                case 'like':
                    $expr = $eb->like($column, $colvalue);
                    break;
                case 'not like':
                    $expr = $eb->notLike($column, $colvalue);
                    break;
                default:
                    $expr = $eb->comparison($column, strtoupper($operator), $colvalue);
                    break;
            }
        } else {
            $expr = '(1)';
        }
        return $expr;
    }
}