Класс FunctionsBuilder

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

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

Краткое описание методов

__call() public
Диспечер магического метода для создания пользовательских вызовов SQL-функций
_build() protected

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

Вспомогательная функция для построения выражения функции, принимающей только один литеральный аргумент.
avg() public
Возвращает FunctionExpression, представляющий вызов SQL-функции AVG.
coalesce() public
Возвращает FunctionExpression, представляющий вызов SQL-функции COALESCE.
concat() public
Возвращает FunctionExpression, представляющий конкатенацию строк
count() public
Возвращает FunctionExpression, представляющий вызов SQL-функции COUNT.
dateAdd() public
Добавляет единицу времени к выражению даты
dateDiff() public

Возвращает FunctionExpression, представляющий разницу в днях между двумя датами.
datePart() public
Возвращает указанную часть даты из SQL-выражения.
dayOfWeek() public

Возвращает FunctionExpression, представляющий вызов SQL-функции WEEKDAY. 1 - Воскресенье, 2 - Понедельник, 3 - Вторник...
extract() public
Возвращает указанную часть даты из SQL-выражения.
max() public
Возвращает FunctionExpression, представляющий вызов SQL-функции MAX.
min() public
Возвращает FunctionExpression, представляющий вызов SQL-функции MIN.
now() public

Возвращает FunctionExpression, представляющий вызов, который вернёт текущую дату и время. По умолчанию возвращает дату и время, но вы также можете заставить его генерировать только дату или только время.
rand() public
Возвращает FunctionExpression, представляющий вызов SQL-функции RAND.
sum() public
Возвращает FunctionExpression, представляющий вызов SQL-функции SUM.
weekday() public

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

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

__call()source public

__call( string $name , array $args )

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

Параметры

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

Возвращает

Cake\Database\Expression\FunctionExpression

_build()source protected

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

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

Параметры

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

Возвращает

Cake\Database\Expression\FunctionExpression

_literalArgumentFunction()source protected

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

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

Параметры

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

Возвращает

Cake\Database\Expression\FunctionExpression

avg()source public

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

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

Параметры

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

Возвращает

Cake\Database\Expression\FunctionExpression

coalesce()source public

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

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

Параметры

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

Возвращает

Cake\Database\Expression\FunctionExpression

concat()source public

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

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

Параметры

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

Возвращает

Cake\Database\Expression\FunctionExpression

count()source public

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

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

Параметры

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

Возвращает

Cake\Database\Expression\FunctionExpression

dateAdd()source public

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

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

Параметры

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

Возвращает

Cake\Database\Expression\FunctionExpression

dateDiff()source public

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

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

Параметры

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

Возвращает

Cake\Database\Expression\FunctionExpression

datePart()source public

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

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

Параметры

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

Возвращает

Cake\Database\Expression\FunctionExpression

dayOfWeek()source public

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

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

Параметры

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

Возвращает

Cake\Database\Expression\FunctionExpression

extract()source public

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

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

Параметры

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

Возвращает

Cake\Database\Expression\FunctionExpression

max()source public

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

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

Параметры

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

Возвращает

Cake\Database\Expression\FunctionExpression

min()source public

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

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

Параметры

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

Возвращает

Cake\Database\Expression\FunctionExpression

now()source public

now( string $type = 'datetime' )

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

Параметры

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

Возвращает

Cake\Database\Expression\FunctionExpression

rand()source public

rand( )

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

Возвращает

Cake\Database\Expression\FunctionExpression

sum()source public

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

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

Параметры

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

Возвращает

Cake\Database\Expression\FunctionExpression

weekday()source public

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

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

Параметры

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

Возвращает

Cake\Database\Expression\FunctionExpression

© 2005–present 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.
https://api.cakephp.org/3.8/class-Cake.Database.FunctionsBuilder.html