Spec-Zone.ru › CakePHP 3.4

Класс 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
END_OF_DOCUMENT_MARKER

_literalArgumentFunction()source protected

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

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

Параметры

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

Возвращает

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

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–2017 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.4/class-Cake.Database.FunctionsBuilder.html

Spec-Zone.ru

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