Класс FunctionsBuilder

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

Пространство имён: Cake\Database
Расположение Database/FunctionsBuilder.php

Подробное описание методов

__callsource public

__call( string $name , array $args )

Магический метод-диспетчер для создания пользовательских вызовов SQL-функций

Параметры

строка $name: имя SQL-функции для построения
массив $args: список до 2-х аргументов, первый из которых - массив с параметрами для SQL-функции, а второй - список типов для привязки к этим параметрам

Возвращает

Cake\Database\Expression\FunctionExpression
\Cake\Database\Expression\FunctionExpression

_buildsource protected

_build( string $name , array $params [] , array $types [] )

Возвращает новый экземпляр FunctionExpression. Используется для генерации произвольных вызовов функций в окончательной строке SQL.

Параметры

строка $name: имя SQL-функции для построения
массив $params необязательно []: список параметров, передаваемых функции
массив $types необязательно []: список типов для каждого параметра функции

Возвращает

Cake\Database\Expression\FunctionExpression
FunctionExpression

_literalArgumentFunctionsource protected

_literalArgumentFunction( string $name , mixed $expression , array $types [] )

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

Параметры

строка $name: имя функции для построения
смешанный тип $expression: аргумент функции
массив $types необязательно []: список типов для привязки к аргументам

Возвращает

Cake\Database\Expression\FunctionExpression
FunctionExpression

avgsource public

avg( mixed $expression , array $types [] )

Возвращает FunctionExpression, представляющий вызов SQL-функции AVG.

Параметры

смешанный тип $expression: аргумент функции
массив $types необязательно []: список типов для привязки к аргументам

Возвращает

Cake\Database\Expression\FunctionExpression
FunctionExpression

coalescesource public

coalesce( array $args , array $types [] )

Возвращает FunctionExpression, представляющий вызов SQL-функции COALESCE.

Параметры

массив $args: Список выражений для оценки в качестве параметров функции
массив $types необязательно []: список типов для привязки к аргументам

Возвращает

Cake\Database\Expression\FunctionExpression
FunctionExpression

concatsource public

concat( array $args , array $types [] )

Возвращает FunctionExpression, представляющий конкатенацию строк

Параметры

массив $args: Список строк или выражений для конкатенации
массив $types необязательно []: список типов для привязки к аргументам

Возвращает

Cake\Database\Expression\FunctionExpression
FunctionExpression

countsource public

count( mixed $expression , array $types [] )

Возвращает FunctionExpression, представляющий вызов SQL-функции COUNT.

Параметры

смешанный тип $expression: аргумент функции
массив $types необязательно []: список типов для привязки к аргументам

Возвращает

Cake\Database\Expression\FunctionExpression
FunctionExpression

dateAddsource public

dateAdd( string $expression , string $value , string $unit , array $types [] )

Добавляет единицу времени к выражению даты

Параметры

строка $expression: Выражение для получения части даты.
строка $value: Значение, которое нужно добавить. Используйте отрицательное значение для вычитания.
строка $unit: Единица измерения значения, например, час или день.
массив $types необязательно []: список типов для привязки к аргументам

Возвращает

Cake\Database\Expression\FunctionExpression
\Cake\Database\Expression\FunctionExpression

dateDiffsource public

dateDiff( array $args , array $types [] )

Возвращает FunctionExpression, представляющий разницу в днях между двумя датами.

Параметры

массив $args: Список выражений для получения разницы в днях.
массив $types необязательно []: список типов для привязки к аргументам

Возвращает

Cake\Database\Expression\FunctionExpression
FunctionExpression

datePartsource public

datePart( string $part , string $expression , array $types [] )

Возвращает указанную часть даты из SQL-выражения.

Параметры

строка $part: Часть даты для возврата.
строка $expression: Выражение для получения части даты.
массив $types необязательно []: список типов для привязки к аргументам

Возвращает

Cake\Database\Expression\FunctionExpression
\Cake\Database\Expression\FunctionExpression

dayOfWeeksource public

dayOfWeek( mixed $expression , array $types [] )

Возвращает FunctionExpression, представляющий вызов SQL-функции WEEKDAY. 1 - Воскресенье, 2 - Понедельник, 3 - Вторник...

Параметры

смешанный тип $expression: аргумент функции
массив $types необязательно []: список типов для привязки к аргументам

Возвращает

Cake\Database\Expression\FunctionExpression
\Cake\Database\Expression\FunctionExpression

extractsource public

extract( string $part , string $expression , array $types [] )

Возвращает указанную часть даты из SQL-выражения.

Параметры

строка $part: Часть даты для возврата.
строка $expression: Выражение для получения части даты.
массив $types необязательно []: список типов для привязки к аргументам

Возвращает

Cake\Database\Expression\FunctionExpression
\Cake\Database\Expression\FunctionExpression

maxsource public

max( mixed $expression , array $types [] )

Возвращает FunctionExpression, представляющий вызов SQL-функции MAX.

Параметры

смешанный тип $expression: аргумент функции
массив $types необязательно []: список типов для привязки к аргументам

Возвращает

Cake\Database\Expression\FunctionExpression
FunctionExpression

minsource public

min( mixed $expression , array $types [] )

Возвращает FunctionExpression, представляющий вызов SQL-функции MIN.

Параметры

смешанный тип $expression: аргумент функции
массив $types необязательно []: список типов для привязки к аргументам

Возвращает

Cake\Database\Expression\FunctionExpression
FunctionExpression

END_OF_DOCUMENT_MARKER

nowsource public

now( string $type 'datetime' )

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

Параметры

строка $type необязательно 'datetime': (datetime|date|time)

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

Cake\Database\Expression\FunctionExpression
\Cake\Database\Expression\FunctionExpression

sumsource public

sum( mixed $expression , array $types [] )

Возвращает FunctionExpression, представляющую вызов функции SQL SUM.

Параметры

смешанное $expression: аргумент функции
массив $types необязательно []: список типов для привязки к аргументам

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

Cake\Database\Expression\FunctionExpression
FunctionExpression

weekdaysource public

weekday( mixed $expression , array $types [] )

Возвращает FunctionExpression, представляющую вызов функции SQL WEEKDAY. 1 — Воскресенье, 2 — Понедельник, 3 — Вторник…

Параметры

смешанное $expression: аргумент функции
массив $types необязательно []: список типов для привязки к аргументам

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

Cake\Database\Expression\FunctionExpression
\Cake\Database\Expression\FunctionExpression

© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.1/class-Cake.Database.FunctionsBuilder.html