Класс OrderByExpression

__construct()source public

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

Конструктор

Параметры

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

Столбцы сортировки

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

Типы для каждого столбца.

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

Разделитель, используемый для объединения условий.

Переопределяет

Cake\Database\Expression\QueryExpression::__construct()

_addConditions()source protected

_addConditions( array $orders , array $types )

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

Новые выражения ORDER BY объединяются с существующими.

Параметры

массив $orders

список выражений ORDER BY

массив $types

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

Переопределяет

Cake\Database\Expression\QueryExpression::_addConditions()

sql()source public

sql( Cake\Database\ValueBinder $generator )

Преобразование выражения в фрагмент SQL.

Параметры

Cake\Database\ValueBinder $generator

Объект генератора маркеров

Возвращает

строка

Переопределяет

Cake\Database\Expression\QueryExpression::sql()

__call()source public

__call( string $method , array $args )

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

Параметры

строка $method

Имя метода.

массив $args

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

Возвращает

Cake\Database\Expression\QueryExpression

Выбрасывает

BadMethodCallException

__clone()source public

__clone( )

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

_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 [] )

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

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

Параметры

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

ассоциативный массив значений, которые будут связаны с условиями, переданными в $conditions. Если значений $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, как настроено с помощью typeMap.

Возвращает

$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( )

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

Возвращает

строка

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, как настроено с помощью Type map.

Возвращает

$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, как настроено с помощью Type map.

Возвращает

$this

hasNestedExpression()source public

hasNestedExpression( )

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

Возвращает

логическое значение

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, как настроено с помощью Type map.

Возвращает

$this

isCallable()source public

isCallable( callable $c )

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

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

Параметры

вызываемый объект $c

Вызываемый объект для проверки.

Возвращает

логическое значение
Допустимый вызываемый объект.

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, как настроено с помощью Type map.

Возвращает

$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, как настроено с помощью Type map.

Возвращает

$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. Будет выглядеть как "НЕ ( (условие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, как настроено с помощью карты типов. Если оно заканчивается на "[]" и значение является массивом, то будет создано несколько заготовок, по одному для каждого значения в массиве.

Возвращает

$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

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 )

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

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

Параметры

вызываемый $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, если $typeMap — массив, иначе обменивает его на предоставленный.

Параметры

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

Создаёт TypeMap, если массив, иначе устанавливает предоставленный TypeMap

Возвращает

$this

typeMap()source public

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

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

Устарело

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

Параметры

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

Создаёт TypeMap, если массив, иначе устанавливает предоставленный TypeMap

Возвращает

$this|\Cake\Database\TypeMap