Класс 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 необязательно 'И'

связующее слово, которое будет объединять все строковые условия на этом уровне древа выражения. Например, "И", "ИЛИ", "ИСКЛЮЧАЮЩЕЕ ИЛИ"...

См. также

\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

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

массив $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 необязательно []

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

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

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

Возвращает

$this

and_()source public

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

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

Параметры

вызов функции|строка|массив|Cake\Database\ExpressionInterface $conditions

для объединения с помощью "И"

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

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

Возвращает

Cake\Database\Expression\QueryExpression

between()source public

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

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

Параметры

строка|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 )

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

Параметры

Cake\Database\ExpressionInterface $query

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

Возвращает

$this

getConjunction()source public

getConjunction( )

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

Возвращает

строка

gt()source public

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

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

Параметры

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

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

смешанное $value

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

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

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

Возвращает

$this

gte()source public

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

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

Параметры

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

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

смешанное $value

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

строка|null $type необязательно 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)».

Параметры

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

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

строка|массив $values

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

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

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

Возвращает

$this

isCallable()source public

isCallable( callable $c )

Проверка того, является ли переданный вызов допустимым.

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

Параметры

вызов $c

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

Возвращает

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

isNotNull()source public

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

Добавляет новое условие к объекту выражения в виде «поле IS NOT NULL».

Параметры

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

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

Возвращает

$this

isNull()source public

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

Добавляет новое условие к объекту выражения в виде «поле IS NULL».

Параметры

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

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

Возвращает

$this

iterateParts()source public

iterateParts( callable $callable )

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

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

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

Параметры

вызов $callable

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

Возвращает

$this

like()source public

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

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

Параметры

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

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

смешанное $value

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

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

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

Возвращает

$this

lt()source public

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

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

Параметры

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

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

смешанное $value

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

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

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

Возвращает

$this

lte()source public

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

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

Параметры

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

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

смешанное $value

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

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

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

Возвращает

$this

not()source public

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

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

Параметры

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

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

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

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

Возвращает

$this

notEq()source public

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

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

Параметры

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

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

смешанное $value

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

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

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

Возвращает

$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_( callable|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 Используйте setConjunction()/getConjunction() вместо этого

Параметры

строка|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 )

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

Этот метод полезен, если вам нужно установить сопоставления типов, которые используются в нескольких функциях/выражениях в запросе.

Для добавления значения по умолчанию без перезаписи существующих используйте getTypeMap()->addDefaults()

Параметры

массив $types

Массив типов для установки.

Возвращает

$this

См. также

\Cake\Database\TypeMap::setDefaults()

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

[]