Класс QueryExpression

__call()source public

__call( string $method , array $args )

Позволяет прозрачно вызывать методы and() и or().

Параметры

строка $method

Имя метода.

массив $args

Аргументы для передачи методу.

Возвращаемое значение

Cake\Database\Expression\QueryExpression

Исключения

BadMethodCallException

__clone()source public

__clone( )

Клонировать этот объект и его поддерево выражений.

__construct()source public

__construct( string|array|Cake\Database\ExpressionInterface $conditions [] , array|Cake\Database\TypeMap $types [] , string $conjunction 'AND' )

Конструктор. Новый объект выражения можно создать без параметров и динамически достраивать. В противном случае можно передать массив условий, содержащий либо древовидную структуру массива для разбора, либо другие объекты выражений. Дополнительно можно задать ключевое слово союза для соединения каждой части дерева выражения на этом уровне.

Параметры

строка|массив|Cake\Database\ExpressionInterface $conditions необязательно []

древовидная структура массива, содержащая все условия, которые необходимо добавить или вложить в этот объект выражения.

массив|Cake\Database\TypeMap $types необязательно []

ассоциативный массив типов, которые необходимо связать со значениями, переданными в $conditions.

строка $conjunction необязательно 'AND'

разделитель, который будет соединять все строковые условия на этом уровне дерева выражения. Например, "AND", "OR", "XOR"...

См. также

\Cake\Database\Expression\QueryExpression::add() для получения дополнительных сведений о $conditions и $types

_addConditions()source protected

_addConditions( array $conditions , array $types )

Вспомогательная функция, используемая для разложения вложенного массива условий и построения древовидной структуры внутри этого объекта для представления всего выражения SQL. Строковые условия хранятся непосредственно в условиях, а любые другие представления оборачиваются соответствующим экземпляром или этого класса.

Параметры

массив $conditions

список условий, которые необходимо сохранить в этом объекте

массив $types

список типов, связанных с полями, на которые ссылаются $conditions

_calculateType()source protected

_calculateType( string|Cake\Database\Expression\IdentifierExpression $field )

Возвращает имя типа для переданного поля, если оно было сохранено в typeMap

Параметры

строка|Cake\Database\Expression\IdentifierExpression $field

Имя поля, для которого требуется получить тип.

Возвращает

строка|null
Вычисленный тип или null, если тип неизвестен.

_parseCondition()source protected

_parseCondition( string $field , mixed $value )

Парсит строковые условия, пытаясь извлечь оператор внутри них, если таковой имеется, и, наконец, возвращает либо соответствующий объект QueryExpression, либо просто строковое представление условия. Эта функция отвечает за создание заготовок и замену значений на них, одновременно храня значение в другом месте для последующей привязки.

Параметры

строка $field

Значение, из которого будет извлечено фактическое поле и оператор.

смешанное $value

Значение, которое должно быть привязано к заготовке для поля

Возвращает

строка|Cake\Database\ExpressionInterface

add()source public

add( string|array|Cake\Database\ExpressionInterface $conditions , array $types [] )

Добавляет одно или несколько условий в этот объект выражения. Условия можно выразить в одномерном массиве, что приведет к добавлению всех условий непосредственно на этом уровне дерева, или они могут быть вложены произвольным образом, что заставит создать больше объектов выражения, которые будут вложены внутрь и настроены на использование указанного союза.

Если тип, переданный для любого из полей, выражен как "тип[]" (обратите внимание на фигурные скобки), это приведет к динамической переработке заготовки. Таким образом, если значение является массивом, будет создано столько заготовок, сколько значений в нём.

Параметры

строка|массив|Cake\Database\ExpressionInterface $conditions

одно или несколько условий, которые необходимо добавить. При использовании массива, и ключ равен 'OR' или 'AND', будет создан новый объект выражения с этим союзом и значением внутреннего массива, переданным в качестве условий.

массив $types необязательно []

ассоциативный массив полей, указывающий на тип значений, которые передаются. Используется для правильной привязки значений к операторам.

Возвращает

$this

См. также

\Cake\Database\Query::where() для примеров условий

addCase()source public

addCase( array|Cake\Database\ExpressionInterface $conditions , array|Cake\Database\ExpressionInterface $values [] , array $types [] )

Добавляет новое выражение case в объект выражения

Параметры

массив|Cake\Database\ExpressionInterface $conditions

условия для проверки. Должен быть экземпляром ExpressionInterface или массивом экземпляров ExpressionInterface.

массив|Cake\Database\ExpressionInterface $values необязательно []

ассоциативный массив значений, которые необходимо связать с переданными условиями. Если значений $values больше, чем условий $conditions, последнее значение $value используется в качестве ELSE значения

массив $types необязательно []

ассоциативный массив типов, которые необходимо связать со значениями, переданными в $values

Возвращает

$this

and_()source public

and_( string|array|Cake\Database\ExpressionInterface $conditions , array $types [] )

Возвращает новый объект QueryExpression, содержащий все переданные условия и настроенный на союз "AND"

Параметры

строка|массив|Cake\Database\ExpressionInterface $conditions

для объединения с AND

массив $types необязательно []

ассоциативный массив полей, указывающий на тип значений, которые передаются. Используется для правильной привязки значений к операторам.

Возвращает

Cake\Database\Expression\QueryExpression

between()source public

between( string|Cake\Database\ExpressionInterface $field , mixed $from , mixed $to , string|null $type null )

Добавляет новое условие в объект выражения в виде "поле BETWEEN от И до".

Параметры

строка|Cake\Database\ExpressionInterface $field

Имя поля для сравнения значений в диапазоне.

смешанное $from

Начальное значение диапазона.

смешанное $to

Конечное значение в диапазоне сравнения.

строка|null $type необязательно null

имя типа для $value, как настроено с помощью Type map.

Возвращает

$this

count()source public

count( )

Возвращает количество внутренних условий, хранящихся в этом выражении. Полезно для определения, является ли этот объект выражения пустым или он сгенерирует непустую строку при компиляции

Возвращает

целое число

Реализация

Countable::count()

eq()source public

eq( string|Cake\Database\ExpressionInterface $field , mixed $value , string|null $type null )

Добавляет новое условие в объект выражения в виде "поле = значение".

Параметры

строка|Cake\Database\ExpressionInterface $field

Базовое поле, которое сравнивается со значением

смешанное $value

Значение, которое должно быть привязано к $field для сравнения

строка|null $type необязательно null

имя типа для $value, как настроено с помощью Type map. Если оно имеет суффикс "[]" и значение является массивом, тогда будут созданы несколько заготовок, по одной на каждое значение в массиве.

Возвращает

$this

equalFields()source public

equalFields( string $left , string $right )

Строит условие равенства или присваивания с идентификатором обертки.

Параметры

строка $left

Имя поля условия левого соединения.

строка $right

Имя поля условия правого соединения.

Возвращает

$this

exists()source public

exists( Cake\Database\ExpressionInterface $query )

Добавляет новое условие в объект выражения в виде "EXISTS (...)".

Параметры

Cake\Database\ExpressionInterface $query

внутренний запрос

Возвращает

$this

getConjunction()source public

getConjunction( )

Получает текущую конъюнкцию, настроенную для условий на данном уровне дерева выражения.

Возвращает

string

gt()source public

gt( string|Cake\Database\ExpressionInterface $field , mixed $value , string|null $type null )

Добавляет новое условие в объект выражения в форме "поле > значение".

Параметры

string|Cake\Database\ExpressionInterface $field

Базовое поле, которое сравнивается со значением

mixed $value

Значение, которое будет привязано к $field для сравнения

string|null $type optional null

Имя типа для $value, настроенное с помощью карты типов.

Возвращает

$this

gte()source public

gte( string|Cake\Database\ExpressionInterface $field , mixed $value , string|null $type null )

Добавляет новое условие в объект выражения в форме "поле >= значение".

Параметры

string|Cake\Database\ExpressionInterface $field

Базовое поле, которое сравнивается со значением

mixed $value

Значение, которое будет привязано к $field для сравнения

string|null $type optional null

Имя типа для $value, настроенное с помощью карты типов.

Возвращает

$this

hasNestedExpression()source public

hasNestedExpression( )

Возвращает true, если данное выражение содержит другие вложенные объекты ExpressionInterface.

Возвращает

boolean

in()source public

in( string|Cake\Database\ExpressionInterface $field , string|array $values , string|null $type null )

Добавляет новое условие в объект выражения в форме "поле IN (значение1, значение2)".

Параметры

string|Cake\Database\ExpressionInterface $field

Базовое поле, которое сравнивается со значением

string|array $values

Значение, которое будет привязано к $field для сравнения

string|null $type optional null

Имя типа для $value, настроенное с помощью карты типов.

Возвращает

$this

isCallable()source public

isCallable( callable $c )

Проверяет, является ли вызов допустимым.

Мы не принимаем обратные вызовы в стиле ['class', 'method'], так как они часто содержат пользовательский ввод, а массивы строк легко подменить.

Параметры

callable $c

Вызов для проверки.

Возвращает

boolean
Допустимый вызов.

isNotNull()source public

isNotNull( string|Cake\Database\ExpressionInterface $field )

Добавляет новое условие в объект выражения в форме "поле IS NOT NULL".

Параметры

string|Cake\Database\ExpressionInterface $field

базовое поле, проверяемое на непустоту

Возвращает

$this

isNull()source public

isNull( string|Cake\Database\ExpressionInterface $field )

Добавляет новое условие в объект выражения в форме "поле IS NULL".

Параметры

string|Cake\Database\ExpressionInterface $field

базовое поле, проверяемое на пустоту

Возвращает

$this

iterateParts()source public

iterateParts( callable $callable )

Выполняет функцию обратного вызова для каждой части, образующей это выражение.

Функция обратного вызова должна возвращать значение, которым будет заменена текущая посещаемая часть. Если функция обратного вызова возвращает null, то часть будет полностью удалена из этого выражения.

Функция обратного вызова получит каждое из условий в качестве первого параметра и ключ как второй параметр. Можно объявить второй параметр как передаваемый по ссылке, это позволит изменить ключ, под которым хранится изменённая часть.

Параметры

callable $callable

Вызов, применяемый к каждой части.

Возвращает

$this

like()source public

like( string|Cake\Database\ExpressionInterface $field , mixed $value , string|null $type null )

Добавляет новое условие в объект выражения в форме "поле LIKE значение".

Параметры

string|Cake\Database\ExpressionInterface $field

Базовое поле, которое сравнивается со значением

mixed $value

Значение, которое будет привязано к $field для сравнения

string|null $type optional null

Имя типа для $value, настроенное с помощью карты типов.

Возвращает

$this

lt()source public

lt( string|Cake\Database\ExpressionInterface $field , mixed $value , string|null $type null )

Добавляет новое условие в объект выражения в форме "поле < значение".

Параметры

string|Cake\Database\ExpressionInterface $field

Базовое поле, которое сравнивается со значением

mixed $value

Значение, которое будет привязано к $field для сравнения

string|null $type optional null

Имя типа для $value, настроенное с помощью карты типов.

Возвращает

$this

lte()source public

lte( string|Cake\Database\ExpressionInterface $field , mixed $value , string|null $type null )

Добавляет новое условие в объект выражения в форме "поле <= значение".

Параметры

string|Cake\Database\ExpressionInterface $field

Базовое поле, которое сравнивается со значением

mixed $value

Значение, которое будет привязано к $field для сравнения

string|null $type optional null

Имя типа для $value, настроенное с помощью карты типов.

Возвращает

$this

not()source public

not( string|array|Cake\Database\ExpressionInterface $conditions , array $types [] )

Добавляет новый набор условий к этому уровню дерева и отрицает итоговый результат, добавив NOT, будет выглядеть как "NOT ( (условие1) И (условия2) )" конъюнкция зависит от текущей, настроенной для этого объекта.

Параметры

string|array|Cake\Database\ExpressionInterface $conditions

для добавления и отрицания

array $types optional []

ассоциативный массив полей, указывающий на тип передаваемых значений. Используется для правильной привязки значений к операторам.

Возвращает

$this

notEq()source public

notEq( string|Cake\Database\ExpressionInterface $field , mixed $value , string|null $type null )

Добавляет новое условие в объект выражения в форме "поле != значение".

Параметры

string|Cake\Database\ExpressionInterface $field

Базовое поле, которое сравнивается со значением

mixed $value

Значение, которое будет привязано к $field для сравнения

string|null $type optional null

имя типа для $value, настроенное с помощью карты типов. Если оно заканчивается на "[]" и значение является массивом, то будут созданы несколько плейсхолдеров, по одному на каждое значение в массиве.

Возвращает

$this

notExists()source public

notExists( Cake\Database\ExpressionInterface $query )

Добавляет новое условие в объект выражения в форме "НЕ СУЩЕСТВУЕТ (...)".

Параметры

Cake\Database\ExpressionInterface $query

внутренний запрос

Возвращает

$this

notIn()source public

notIn( string|Cake\Database\ExpressionInterface $field , array $values , string|null $type null )

Добавляет новое условие к объекту выражения в форме «поле НЕ В (значение1, значение2)».

Параметры

строка|Cake\Database\ExpressionInterface $field

Поле базы данных, которое должно быть сравнено со значением

массив $values

значение, которое должно быть привязано к $field для сравнения

строка|null $type необязательно null

имя типа для $value, настроенное с помощью карты типов.

Возвращает

$this

notLike()source public

notLike( string|Cake\Database\ExpressionInterface $field , mixed $value , string|null $type null )

Добавляет новое условие к объекту выражения в форме «поле НЕ ПОДОБНО значение».

Параметры

строка|Cake\Database\ExpressionInterface $field

Поле базы данных, которое должно быть сравнено со значением

смешанный $value

Значение, которое должно быть привязано к $field для сравнения

строка|null $type необязательно null

имя типа для $value, настроенное с помощью карты типов.

Возвращает

$this

or_()source public

or_( string|array|Cake\Database\ExpressionInterface $conditions , array $types [] )

Возвращает новый объект QueryExpression, содержащий все переданные условия, и устанавливает сопряжение в «ИЛИ»

Параметры

строка|массив|Cake\Database\ExpressionInterface $conditions

для объединения с ИЛИ

массив $types необязательно []

ассоциативный массив полей, указывающих на тип значений, которые передаются. Используется для правильной привязки значений к операторам.

Возвращает

Cake\Database\Expression\QueryExpression

setConjunction()source public

setConjunction( string $conjunction )

Изменяет сопряжение для условий на этом уровне дерева выражений.

Параметры

строка $conjunction

Значение, используемое для объединения условий

Возвращает

$this

sql()source public

sql( Cake\Database\ValueBinder $generator )

Возвращает строковое представление этого объекта для использования в запросе SQL. Обратите внимание, что значения условий не включены в строку, на их месте стоят плейсхолдеры, которые можно заменить соответствующими процитированными значениями.

Параметры

Cake\Database\ValueBinder $generator

Объект генератора плейсхолдеров

Возвращает

строка

Реализация

Cake\Database\ExpressionInterface::sql()

tieWith()source public

tieWith( string|null $conjunction null )

Изменяет сопряжение для условий на этом уровне дерева выражений. Если вызвать без аргументов, вернет текущее значение.

Устарело

3.4.0 Используйте setConjunction()/getConjunction() вместо этого.

Параметры

строка|null $conjunction необязательно null

значение, используемое для объединения условий. Если null, то не будет устанавливаться значение, а вернётся текущее сохранённое.

Возвращает

строка|Cake\Database\Expression\QueryExpression
$this

traverse()source public

traverse( callable $callable )

Проходит по структуре дерева выражения этого запроса, выполняя функцию обратного вызова для каждого из условий, включённых в этот объект. Полезно для компиляции конечного выражения или для интроспекции структуры.

Функция обратного вызова получает в качестве единственного аргумента экземпляр ExpressionInterface

Параметры

вызов $callable

Вызов, который применяется ко всем подвыражениям.

Реализация

Cake\Database\ExpressionInterface::traverse()

type()source public

type( string|null $conjunction null )

Обратный вызов совместимости для tieWith()

Устарело

3.2.0 Используйте tieWith() вместо этого.

Параметры

строка|null $conjunction необязательно null

значение, используемое для объединения условий. Если null, то не будет устанавливаться значение, а вернётся текущее сохранённое.

Возвращает

строка|Cake\Database\Expression\QueryExpression
$this

defaultTypes()source public

defaultTypes( array $types null )

Позволяет установить значения по умолчанию для типов при цепочечном выполнении запроса

Устарело

3.4.0 Используйте setDefaultTypes()/getDefaultTypes() вместо этого.

Параметры

массив $types необязательно null

Массив типов, которые нужно установить.

Возвращает

$this|массив

getDefaultTypes()source public

getDefaultTypes( )

Получает значения по умолчанию для типов текущей карты типов.

Возвращает

массив

getTypeMap()source public

getTypeMap( )

Возвращает существующую карту типов.

Возвращает

Cake\Database\TypeMap

setDefaultTypes()source public

setDefaultTypes( array $types )

Позволяет установить значения по умолчанию для типов при цепочечном выполнении запроса.

Параметры

массив $types

Массив типов, которые нужно установить.

Возвращает

$this

setTypeMap()source public

setTypeMap( array|Cake\Database\TypeMap $typeMap )

Создаёт новую карту типов, если $typeMap является массивом, иначе меняет её на переданную.

Параметры

массив|Cake\Database\TypeMap $typeMap

Создаёт карту типов, если массив, иначе устанавливает переданную карту типов

Возвращает

$this

typeMap()source public

typeMap( array|Cake\Database\TypeMap|null $typeMap null )

Создаёт новую карту типов, если $typeMap является массивом, иначе возвращает существующую карту типов или меняет её на переданную.

Устарело

3.4.0 Используйте setTypeMap()/getTypeMap() вместо этого.

Параметры

массив|Cake\Database\TypeMap|null $typeMap необязательно null

Создаёт карту типов, если массив, иначе устанавливает переданную карту типов

Возвращает

$this|\Cake\Database\TypeMap

[]