Открытые члены
	__construct ()
	ConditionTree constructor. Подробнее...

	logic ($logic=null)
	All conditions will be imploded by this logic: static::LOGIC_AND or static::LOGIC_OR. Подробнее...

	negative ($negative=true)
	Sets NOT before all the conditions. Подробнее...

	where ()
	General condition. Подробнее...

	whereNot ()
	Sets NOT before any conditions or subfilter. Подробнее...

	whereColumn ()
	The same logic as where(), but value will be taken as another column name. Подробнее...

	whereNull ($column)
	Compares column with NULL. Подробнее...

	whereNotNull ($column)
	Compares column with NOT NULL. Подробнее...

	whereIn ($column, $values)
	IN() condition. Подробнее...

	whereNotIn ($column, $values)
	Negative IN() condition. Подробнее...

	whereBetween ($column, $valueMin, $valueMax)
	BETWEEN condition. Подробнее...

	whereNotBetween ($column, $valueMin, $valueMax)
	Negative BETWEEN condition. Подробнее...

	whereLike ($column, $value)
	LIKE condition, without default % placement. Подробнее...

	whereNotLike ($column, $value)
	Negative LIKE condition, without default % placement. Подробнее...

	whereExists ($query)
	Exists() condition. Подробнее...

	whereNotExists ($query)
	Negative Exists() condition. Подробнее...

	whereMatch ($column, $value)
	Fulltext search condition. Подробнее...

	whereNotMatch ($column, $value)
	Negative fulltext search condition. Подробнее...

	getSql ($chains)
	Returns SQL for all conditions and subfilters. Подробнее...

	getConditions ()
	Returns all conditions and subfilters. Подробнее...

	addCondition ($condition)
	Adds prepared condition. Подробнее...

	hasConditions ()
	Checks if filter is not empty. Подробнее...

	replaceCondition ($currentCondition, $newCondition)
	Replaces condition with a new one. Подробнее...

	removeCondition ($condition)
	Removes one condition. Подробнее...

	removeAllConditions ()
	Removes all conditions. Подробнее...

	__clone ()

Поля данных
const	LOGIC_OR = 'or'

const	LOGIC_AND = 'and'

Защищенные члены
	convertValue ($value, IReadable $field=null)
	Converts any value to raw SQL, except of NULL, which is supposed to be handled in Operator. Подробнее...

	convertValues ($values, IReadable $field=null)
	Converts array of values to raw SQL. Подробнее...

Защищенные данные
	$chains

	$conditions = array()

	$logic

	$isNegative = false

Подробное описание

См. определение в файле conditiontree.php строка 23

Конструктор(ы)

◆ __construct()

__construct ( )

ConditionTree constructor.

См. определение в файле conditiontree.php строка 50

     {
         $this->logic = static::LOGIC_AND;
     }

Методы

◆ __clone()

__clone ( )

См. определение в файле conditiontree.php строка 674

     {
         $newConditions = array();
  
         foreach ($this->conditions as $condition)
         {
             $newConditions[] = clone $condition;
         }
  
         $this->conditions = $newConditions;
     }

◆ addCondition()

addCondition ( $condition )

Adds prepared condition.

Аргументы

Condition | ConditionTree $condition

Возвращает: $this

Исключения

ArgumentException

См. определение в файле conditiontree.php строка 535

     {
         if ($condition instanceof Condition || $condition instanceof ConditionTree)
         {
             $this->conditions[] = $condition;
             return $this;
         }
  
         throw new ArgumentException('Unknown type of condition '.gettype($condition));
     }

◆ convertValue()

convertValue	(		$value,
		IReadable	$field = `null`
	)

protected

Converts any value to raw SQL, except of NULL, which is supposed to be handled in Operator.

Аргументы

mixed	$value
IReadable	$field

Возвращает: mixed|null|string

Исключения

ArgumentException
SystemException

См. определение в файле conditiontree.php строка 617

     {
         // any sql expression
         if ($value instanceof SqlExpression)
         {
             return $value->compile();
         }
  
         // subquery
         if ($value instanceof Query)
         {
             return $value->getQuery();
         }
  
         // subfilter
         if ($value instanceof ConditionTree)
         {
             return $value->getSql($this->chains);
         }
  
         // nulls
         if ($value === null)
         {
             return new Expressions\NullExpression;
         }
  
         if ($value instanceof Expressions\ColumnExpression)
         {
             /** @var Chain $valueChain */
             $valueChain = $this->chains[$value->getDefinition()];
             return $valueChain->getSqlDefinition();
         }
  
         return $field->convertValueToDb($value); // give them current sql helper
     }

◆ convertValues()

convertValues	(		$values,
		IReadable	$field = `null`
	)

protected

Converts array of values to raw SQL.

См. также: ConditionTree::convertValue()

Аргументы

array	$values
\Bitrix\Main\ORM\Fields\IReadable \| null	$field

Возвращает: array

Исключения

ArgumentException
SystemException

См. определение в файле conditiontree.php строка 664

     {
         foreach ($values as $k => $value)
         {
             $values[$k] = $this->convertValue($value, $field);
         }
  
         return $values;
     }

◆ getConditions()

getConditions ( )

Returns all conditions and subfilters.

Возвращает: ConditionTree[]|Condition[]

См. определение в файле conditiontree.php строка 522

     {
         return $this->conditions;
     }

◆ getSql()

getSql ( $chains )

Returns SQL for all conditions and subfilters.

Аргументы

Chain[] $chains

Возвращает: string

Исключения

ArgumentException
SystemException

См. определение в файле conditiontree.php строка 443

     {
         // save chains
         $this->chains = $chains;
  
         $finalSql = array();
  
         // build sql
         foreach ($this->conditions as $condition)
         {
             if ($condition instanceof ConditionTree)
             {
                 // subfilter
                 $subFilter = $condition;
                 $sql = $subFilter->getSql($chains);
  
                 if (count($subFilter->getConditions()) > 1)
                 {
                     $sql = "({$sql})";
                 }
             }
             else
             {
                 // regular condition
                 $columnSqlDefinition = null;
                 $columnField = null;
  
                 // define column field
                 if ($condition->getColumn() !== null)
                 {
                     $chain = $chains[$condition->getDefinition()];
                     $columnSqlDefinition = $chain->getSqlDefinition();
  
                     /** @var IReadable $columnField */
                     $columnField = $chain->getLastElement()->getValue();
                 }
  
                 // final value's sql
                 if (in_array($condition->getOperator(), array('in', 'between'), true) && is_array($condition->getValue()))
                 {
                     // value is in array of atomic values
                     $finalValue = $this->convertValues($condition->getValue(), $columnField);
                 }
                 else
                 {
                     $finalValue = $this->convertValue($condition->getValue(), $columnField);
                 }
  
                 // operation method
                 $operators = Operator::get();
                 $operator = $operators[$condition->getOperator()];
  
                 // final sql
                 $sql = call_user_func(
                     array('Bitrix\Main\ORM\Query\Filter\Operator', $operator),
                     $columnSqlDefinition, $finalValue
                 );
             }
  
             $finalSql[] = $sql;
         }
  
         // concat with $this->logic
         $sql = join(" ".strtoupper($this->logic)." ", $finalSql);
  
         // and put NOT if negative
         if ($this->isNegative)
         {
             $sql = count($finalSql) > 1 ? "NOT ({$sql})" : "NOT {$sql}";
         }
  
         return $sql;
     }

◆ hasConditions()

hasConditions ( )

Checks if filter is not empty.

Возвращает: bool

См. определение в файле conditiontree.php строка 551

     {
         return !empty($this->conditions);
     }

◆ logic()

logic ( $logic = null )

All conditions will be imploded by this logic: static::LOGIC_AND or static::LOGIC_OR.

Аргументы

string $logic and|or

Возвращает: $this|string

Исключения

ArgumentException

См. определение в файле conditiontree.php строка 63

     {
         if ($logic === null)
         {
             return $this->logic;
         }
  
         if (!in_array(strtolower($logic), [static::LOGIC_AND, static::LOGIC_OR], true))
         {
             throw new ArgumentException("Unknown logic");
         }
  
         $this->logic = strtolower($logic);
  
         return $this;
     }

◆ negative()

negative ( $negative = true )

Sets NOT before all the conditions.

Аргументы

bool $negative

Возвращает: $this

См. определение в файле conditiontree.php строка 87

     {
         $this->isNegative = $negative;
         return $this;
     }

◆ removeAllConditions()

removeAllConditions ( )

Removes all conditions.

См. определение в файле conditiontree.php строка 602

     {
         $this->conditions = [];
     }

◆ removeCondition()

removeCondition ( $condition )

Removes one condition.

Аргументы

$condition

Возвращает: bool

См. определение в файле conditiontree.php строка 585

     {
         foreach ($this->conditions as $k => $_condition)
         {
             if ($condition === $_condition)
             {
                 unset($this->conditions[$k]);
                 return true;
             }
         }
  
         return false;
     }

◆ replaceCondition()

replaceCondition	(	$currentCondition,
		$newCondition
	)

Replaces condition with a new one.

Аргументы

$currentCondition
$newCondition

Возвращает: bool

См. определение в файле conditiontree.php строка 564

     {
         foreach ($this->conditions as $k => $condition)
         {
             if ($condition === $currentCondition)
             {
                 $this->conditions[$k] = $newCondition;
                 return true;
             }
         }
  
         return false;
     }

◆ where()

where ( )

General condition.

In regular case used with 3 parameters: where(columnName, operator, value), e.g. ('ID', '=', 1); ('SALARY', '>', '500')

List of available operators can be found in Operator class.

См. также: Operator::$operators

Can be used in short format: where(columnName, value), with operator '=' by default Can be used in ultra short format: where(columnName), for boolean fields only

Can be used for subfilter set: where(ConditionTree subfilter)

Instead of columnName, you can use runtime field: where(new ExpressionField('TMP', 'CONCAT(s, s)', ["NAME", "LAST_NAME"]), 'Anton Ivanov') or with expr helper where(Query::expr()->concat("NAME", "LAST_NAME"), 'Anton Ivanov')

Аргументы

array ...$filter

Возвращает: $this

Исключения

ArgumentException

См. определение в файле conditiontree.php строка 118

     {
         $filter = func_get_args();
  
         // subfilter
         if (count($filter) == 1 && $filter[0] instanceof ConditionTree)
         {
             $this->conditions[] = $filter[0];
             return $this;
         }
  
         // ready condition
         if (count($filter) == 1 && $filter[0] instanceof Condition)
         {
             $this->conditions[] = $filter[0];
             return $this;
         }
  
         // array of conditions
         if (count($filter) == 1 && is_array($filter[0]))
         {
             foreach ($filter[0] as $condition)
             {
                 // call `where` for each condition
                 call_user_func_array(array($this, 'where'), $condition);
             }
             return $this;
         }
  
         // regular conditions
         if (count($filter) == 3)
         {
             // everything is clear
             list($column, $operator, $value) = $filter;
         }
         elseif (count($filter) == 2)
         {
             // equal by default
             list($column, $value) = $filter;
             $operator = '=';
         }
         elseif (count($filter) == 1)
         {
             // suppose it is boolean field with true value
             $column = $filter[0];
             $operator = '=';
             $value = true;
         }
         else
         {
             throw new ArgumentException('Wrong arguments');
         }
  
         // validate operator
         $operators = Operator::get();
         if (!isset($operators[$operator]))
         {
             throw new ArgumentException("Unknown operator `{$operator}`");
         }
  
         // add condition
         $this->conditions[] = new Condition($column, $operator, $value);
  
         return $this;
     }

◆ whereBetween()

whereBetween	(	$column,
		$valueMin,
		$valueMax
	)

BETWEEN condition.

Аргументы

$column
$valueMin
$valueMax

Возвращает: $this

См. определение в файле conditiontree.php строка 308

     {
         $this->conditions[] = new Condition($column, 'between', array($valueMin, $valueMax));
  
         return $this;
     }

◆ whereColumn()

whereColumn ( )

The same logic as where(), but value will be taken as another column name.

См. также: ConditionTree::where()

Аргументы

array ...$filter

Возвращает: $this

Исключения

ArgumentException

См. определение в файле conditiontree.php строка 212

     {
         $filter = func_get_args();
  
         if (count($filter) == 3)
         {
             list($column, $operator, $value) = $filter;
         }
         elseif (count($filter) == 2)
         {
             list($column, $value) = $filter;
             $operator = '=';
         }
         else
         {
             throw new ArgumentException('Wrong arguments');
         }
  
         // convert value to column format
         $value = new Expressions\ColumnExpression($value);
  
         // put through general method
         $this->where($column, $operator, $value);
  
         return $this;
     }

◆ whereExists()

whereExists ( $query )

Exists() condition.

Can be used with Query object or plain sql wrapped with SqlExpression.

Аргументы

Query | SqlExpression $query

Возвращает: $this

См. определение в файле conditiontree.php строка 372

     {
         $this->conditions[] = new Condition(null, 'exists', $query);
  
         return $this;
     }

◆ whereIn()

whereIn	(	$column,
		$values
	)

IN() condition.

Аргументы

string	$column
array \| Query \| SqlExpression	$values

Возвращает: $this

См. определение в файле conditiontree.php строка 275

     {
         $this->conditions[] = new Condition($column, 'in', $values);
  
         return $this;
     }

◆ whereLike()

whereLike	(	$column,
		$value
	)

LIKE condition, without default % placement.

Аргументы

$column
$value

Возвращает: $this

См. определение в файле conditiontree.php строка 341

     {
         $this->conditions[] = new Condition($column, 'like', $value);
  
         return $this;
     }

◆ whereMatch()

whereMatch	(	$column,
		$value
	)

Fulltext search condition.

См. также: Helper::matchAgainstWildcard() for preparing $value for AGAINST.

Аргументы

$column
$value

Возвращает: $this

См. определение в файле conditiontree.php строка 410

     {
         $this->conditions[] = new Condition($column, 'match', $value);
  
         return $this;
     }

◆ whereNot()

whereNot ( )

Sets NOT before any conditions or subfilter.

См. также: ConditionTree::where()

Аргументы

array ...$filter

Возвращает: $this

См. определение в файле conditiontree.php строка 192

     {
         $filter = func_get_args();
  
         $subFilter = new static();
         call_user_func_array(array($subFilter, 'where'), $filter);
  
         $this->conditions[] = $subFilter->negative();
         return $this;
     }

◆ whereNotBetween()

whereNotBetween	(	$column,
		$valueMin,
		$valueMax
	)

Negative BETWEEN condition.

См. также: ConditionTree::whereBetween()

Аргументы

$column
$valueMin
$valueMax

Возвращает: $this

См. определение в файле conditiontree.php строка 325

     {
         $subFilter = new static();
         $this->conditions[] = $subFilter->whereBetween($column, $valueMin, $valueMax)->negative();
  
         return $this;
     }

◆ whereNotExists()

whereNotExists ( $query )

Negative Exists() condition.

Can be used with Query object or plain sql wrapped with SqlExpression.

См. также: ConditionTree::whereExists()

Аргументы

Query | SqlExpression $query

Возвращает: $this

Исключения

ArgumentException

См. определение в файле conditiontree.php строка 388

     {
         if ($query instanceof Query || $query instanceof SqlExpression)
         {
             $subFilter = new static();
             $this->conditions[] = $subFilter->whereExists($query)->negative();
  
             return $this;
         }
  
         throw new ArgumentException('Unknown type of query '.gettype($query));
     }

◆ whereNotIn()

whereNotIn	(	$column,
		$values
	)

Negative IN() condition.

См. также: ConditionTree::whereIn()

Аргументы

string	$column
array \| Query \| SqlExpression	$values

Возвращает: $this

См. определение в файле conditiontree.php строка 291

     {
         $subFilter = new static();
         $this->conditions[] = $subFilter->whereIn($column, $values)->negative();
  
         return $this;
     }

◆ whereNotLike()

whereNotLike	(	$column,
		$value
	)

Negative LIKE condition, without default % placement.

См. также: ConditionTree::whereLike()

Аргументы

$column
$value

Возвращает: $this

См. определение в файле conditiontree.php строка 357

     {
         $subFilter = new static();
         $this->conditions[] = $subFilter->whereLike($column, $value)->negative();
  
         return $this;
     }

◆ whereNotMatch()

whereNotMatch	(	$column,
		$value
	)

Negative fulltext search condition.

См. также: Helper::matchAgainstWildcard() for preparing $value for AGAINST.

Аргументы

$column
$value

Возвращает: $this

См. определение в файле conditiontree.php строка 426

     {
         $subFilter = new static();
         $this->conditions[] = $subFilter->whereMatch($column, $value)->negative();
  
         return $this;
     }

◆ whereNotNull()

whereNotNull ( $column )

Compares column with NOT NULL.

Аргументы

string $column

Возвращает: $this

См. определение в файле conditiontree.php строка 260

     {
         $this->conditions[] = new Condition($column, '<>', null);
  
         return $this;
     }

◆ whereNull()

whereNull ( $column )

Compares column with NULL.

Аргументы

string $column

Возвращает: $this

См. определение в файле conditiontree.php строка 246

     {
         $this->conditions[] = new Condition($column, '=', null);
  
         return $this;
     }

Поля

◆ $chains

$chains

protected

См. определение в файле conditiontree.php строка 26

◆ $conditions

$conditions = array()

protected

См. определение в файле conditiontree.php строка 29

◆ $isNegative

$isNegative = false

protected

См. определение в файле conditiontree.php строка 45

◆ $logic

$logic

protected

См. определение в файле conditiontree.php строка 35

◆ LOGIC_AND

const LOGIC_AND = 'and'

См. определение в файле conditiontree.php строка 39

◆ LOGIC_OR

const LOGIC_OR = 'or'

См. определение в файле conditiontree.php строка 37

Объявления и описания членов класса находятся в файле:

conditiontree.php

Открытые члены

Поля данных

Защищенные члены

Защищенные данные

Подробное описание

Конструктор(ы)

◆ __construct()

Методы

◆ __clone()

◆ addCondition()

◆ convertValue()

◆ convertValues()

◆ getConditions()

◆ getSql()

◆ hasConditions()

◆ logic()

◆ negative()

◆ removeAllConditions()

◆ removeCondition()

◆ replaceCondition()

◆ where()

◆ whereBetween()

◆ whereColumn()

◆ whereExists()

◆ whereIn()

◆ whereLike()

◆ whereMatch()

◆ whereNot()

◆ whereNotBetween()

◆ whereNotExists()

◆ whereNotIn()

◆ whereNotLike()

◆ whereNotMatch()

◆ whereNotNull()

◆ whereNull()

Поля

◆ $chains

◆ $conditions

◆ $isNegative

◆ $logic

◆ LOGIC_AND

◆ LOGIC_OR