Spec-Zone.ru › CakePHP 3.6

Класс 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, представляющий вызов, который вернёт текущую дату и время. По умолчанию возвращает и дату, и время, но также можно настроить генерацию только даты или только времени.

  • sum() public
    Возвращает FunctionExpression, представляющий вызов SQL-функции SUM.
  • weekday() public

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

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

__call()source public

__call( string $name , array $args )

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

Параметры

string $name
имя SQL-функции для построения
array $args

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

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

Cake\Database\Expression\FunctionExpression

_build()source protected

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

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

Параметры

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

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

Cake\Database\Expression\FunctionExpression

_literalArgumentFunction()source protected

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

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

Параметры

string $name
имя функции для построения
mixed $expression
аргумент функции
array $types optional []
список типов для привязки к аргументам
string $return optional 'string'
Тип возвращаемого значения функции

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

Cake\Database\Expression\FunctionExpression

avg()source public

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

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

Параметры

mixed $expression
аргумент функции
array $types optional []
список типов для привязки к аргументам

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

Cake\Database\Expression\FunctionExpression

coalesce()source public

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

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

Параметры

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

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

Cake\Database\Expression\FunctionExpression

concat()source public

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

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

Параметры

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

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

Cake\Database\Expression\FunctionExpression

count()source public

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

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

Параметры

mixed $expression
аргумент функции
array $types optional []
список типов для привязки к аргументам

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

Cake\Database\Expression\FunctionExpression

dateAdd()source public

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

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

Параметры

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

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

Cake\Database\Expression\FunctionExpression

dateDiff()source public

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

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

Параметры

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

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

Cake\Database\Expression\FunctionExpression
END_OF_DOCUMENT_MARKER

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

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.6/class-Cake.Database.FunctionsBuilder.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API