Spec-Zone.ru › CakePHP 3.3

Интерфейс ConnectionInterface

Этот интерфейс определяет методы, на которые вы можете положиться при подключении.

Прямые реализаторы

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

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

  • config() public
    Получить данные конфигурации, используемые для создания подключения.
  • configName() public
    Получить имя конфигурации для этого подключения.
  • disableConstraints() public
    Выполнить операцию с отключёнными ограничениями.
  • logQueries() public
    Включает или отключает протоколирование запросов для этого подключения.
  • logger() public

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

  • transactional() public

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

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

config()source public

config( )

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

Возвращает

массив

configName()source public

configName( )

Получить имя конфигурации для этого подключения.

Возвращает

строка

disableConstraints()source public

disableConstraints( callable $operation )

Выполнить операцию с отключёнными ограничениями.

Ограничения должны быть повторно включены после успешного/неуспешного выполнения обратного вызова.

Параметры

обратный_вызов $operation
Обратный вызов для выполнения внутри транзакции.

Возвращает

смешанное
Значение, возвращаемое обратным вызовом.

Выбрасывает

Исключение

Перебросит любое исключение, поднятое в $callback, после отката транзакции.


logQueries()source public

logQueries( boolean|null $enable null )

Включает или отключает протоколирование запросов для этого подключения.

Параметры

булево|null $enable необязательно null

включать или отключать протоколирование. Используйте null, чтобы прочитать текущее значение.

Возвращает

булево

logger()source public

logger( object|null $instance null )

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

Параметры

объект|null $instance необязательно null
экземпляр объекта логгера

Возвращает

объект
экземпляр логгера

transactional()source public

transactional( callable $transaction )

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

Обратный вызов получит экземпляр подключения в качестве первого аргумента.

Параметры

обратный_вызов $transaction
Обратный вызов для выполнения внутри транзакции.

Возвращает

смешанное
Значение, возвращаемое обратным вызовом.

Выбрасывает

Исключение

Перебросит любое исключение, поднятое в $callback, после отката транзакции.


© 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.3/class-Cake.Datasource.ConnectionInterface.html

Spec-Zone.ru

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