Bitrix API

Condition

Single condition handler.

Tags
subpackage

main

Table of Contents

Methods

__clone()  : mixed
__construct()  : mixed
QueryFilterCondition constructor.
getAtomicValues()  : array<string|int, mixed>
Returns value as a set of atomic (composite) values.
getColumn()  : string|Field
getDefinition()  : string|Field|null
getOperator()  : string
getValue()  : mixed|ColumnExpression
hasMultiValues()  : bool
Checks for multi-values (array for IN etc.)
setColumn()  : mixed
setDefinition()  : mixed
setOperator()  : mixed
setValue()  : mixed

Methods

__construct()

QueryFilterCondition constructor.

public __construct(string|Field|null $column, string $operator, mixed $value) : mixed
Parameters
$column : string|Field|null
$operator : string
$value : mixed

getAtomicValues()

Returns value as a set of atomic (composite) values.

public getAtomicValues() : array<string|int, mixed>

In classic condition there is only one value v1. In whereIn there is an array [v1, v2, v3, ...]. In whereBetween there are two values v1, v2. etc.

This method returns array of all the values regardless the operator.

Return values
array<string|int, mixed>

getOperator()

public getOperator() : string
Return values
string

hasMultiValues()

Checks for multi-values (array for IN etc.)

public hasMultiValues() : bool
Return values
bool

setColumn()

public setColumn(string|Field|null $column) : mixed
Parameters
$column : string|Field|null

setDefinition()

public setDefinition(string|Field|null $definition) : mixed
Parameters
$definition : string|Field|null

setOperator()

public setOperator(string $operator) : mixed
Parameters
$operator : string

setValue()

public setValue(mixed $value) : mixed
Parameters
$value : mixed

        
On this page

Search results