Класс FunctionExpression

__construct()source public

__construct( string $name , array $params [] , array $types [] , string $returnType 'string' )

Конструктор. Принимает имя вызываемой функции и список параметров, которые нужно передать в функцию. Дополнительно можно передать список типов, которые будут использоваться для каждого связанного параметра.

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

Примеры:

$f = new FunctionExpression('CONCAT', ['CakePHP', ' rules']);

Предыдущая строка сгенерирует CONCAT('CakePHP', ' rules')

$f = new FunctionExpression('CONCAT', ['name' => 'literal', ' rules']);

Что даст CONCAT(name, ' rules')

Параметры

строка $name

имя создаваемой функции

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

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

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

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

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

Тип возвращаемого значения этого выражения

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

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

add()source public

add( array $params , array $types [] , boolean $prepend false )

Добавляет один или несколько аргументов для вызова функции.

Параметры

массив $params

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

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

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

булево $prepend необязательно false

Вставить перед или после списка аргументов

Возвращает

$this

См.

\Cake\Database\Expression\FunctionExpression::__construct() для получения более подробной информации.

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

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

count()source public

count( )

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

Возвращает

целое число

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

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

getName()source public

getName( )

Получает имя SQL-функции, которая должна быть вызвана в этом выражении.

Возвращает

строка

name()source public

name( string|null $name null )

Устанавливает имя SQL-функции, которая должна быть вызвана в этом выражении, если значение не передано, то вернётся текущее имя

Устарело

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

Параметры

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

Имя функции

Возвращает

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

setName()source public

setName( string $name )

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

Параметры

строка $name

Имя функции

Возвращает

$this

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

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

_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

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, содержащий все переданные условия и устанавливает конъюнкцию в «И»

Параметры

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

Возвращает

$this

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, как настроено с помощью карты типов. Если оно имеет суффикс «[]» и значение является массивом, будут созданы несколько заглушек, по одной на каждое значение в массиве.

Возвращает

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

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

Параметры

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

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

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

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

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

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

Возвращает

$this

isCallable()source public

isCallable( callable $c )

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

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

Параметры

callable $c

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

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

boolean
Допустимый вызываемый объект.

isNotNull()source public

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

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

Параметры

string|Cake\Database\ExpressionInterface $field

Поле базы данных, которое должно быть проверено на непустоту

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

$this

isNull()source public

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

Добавляет новое условие в объект выражения в виде "поле равно 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 необязательно null

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

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

$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 необязательно null

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

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

$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 необязательно null

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

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

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

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

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

$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 необязательно null

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

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

$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)".

Параметры

string|Cake\Database\ExpressionInterface $field

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

array $values

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

string|null $type необязательно null

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

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

$this

notLike()source public

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

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

Параметры

string|Cake\Database\ExpressionInterface $field

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

mixed $value

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

string|null $type необязательно null

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

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

$this

or_()source public

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

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

Параметры

string|array|Cake\Database\ExpressionInterface $conditions

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

array $types необязательно []

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

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

Cake\Database\Expression\QueryExpression

setConjunction()source public

setConjunction( string $conjunction )

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

Параметры

string $conjunction

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

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

$this

tieWith()source public

tieWith( string|null $conjunction null )

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

Устаревшее

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

Параметры

string|null $conjunction необязательный null

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

Возвращает

string|Cake\Database\Expression\QueryExpression
$this

traverse()source public

traverse( callable $callable )

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

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

Параметры

callable $callable

Функция обратного вызова, которая применяется ко всем подвыражениям.

Реализация

Cake\Database\ExpressionInterface::traverse()

type()source public

type( string|null $conjunction null )

Обратная совместимость обёртки для tieWith()

Устаревшее

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

Параметры

string|null $conjunction необязательный null

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

Возвращает

string|Cake\Database\Expression\QueryExpression
$this

_castToExpression()source protected

_castToExpression( mixed $value , string $type )

Условно преобразует переданное значение в объект ExpressionInterface, если класс типа реализует ExpressionTypeInterface. В противном случае возвращает значение без изменений.

Параметры

mixed $value

Значение, которое нужно преобразовать в ExpressionInterface

string $type

Имя типа

Возвращает

mixed

_requiresToExpressionCasting()source protected

_requiresToExpressionCasting( array $types )

Возвращает массив с типами, которые требуют преобразования значений в выражения, из списка имён типов, переданных в качестве параметра.

Параметры

array $types

Список имён типов

Возвращает

array

getReturnType()source public

getReturnType( )

Получает тип значения, которое сгенерирует этот объект.

Возвращает

string

returnType()source public

returnType( string|null $type null )

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

Устаревшее

3.5.0 Используйте getReturnType()/setReturnType() вместо этого.

Параметры

string|null $type необязательный null

Имя типа, который нужно вернуть

Возвращает

string|Cake\Database\TypedResultTrait
$this

setReturnType()source public

setReturnType( string $type )

Устанавливает тип значения, которое сгенерирует этот объект.

Параметры

string $type

Имя типа, который нужно вернуть

Возвращает

$this

defaultTypes()source public

defaultTypes( array $types null )

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

Устаревшее

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

Параметры

array $types необязательный null

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

Возвращает

$this|array

getDefaultTypes()source public

getDefaultTypes( )

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

Возвращает

array

getTypeMap()source public

getTypeMap( )

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

Возвращает

Cake\Database\TypeMap

setDefaultTypes()source public

setDefaultTypes( array $types )

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

Параметры

array $types

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

Возвращает

$this

setTypeMap()source public

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

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

Параметры

array|Cake\Database\TypeMap $typeMap

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

Возвращает

$this

typeMap()source public

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

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

Устаревшее

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

Параметры

array|Cake\Database\TypeMap|null $typeMap необязательный null

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

Возвращает

$this|\Cake\Database\TypeMap