Spec-Zone.ru › CakePHP 3.2

Интерфейс 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( )

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

Возвращает

array

configName()source public

configName( )

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

Возвращает

string

disableConstraints()source public

disableConstraints( callable $operation )

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

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

Параметры

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

Возвращает

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

Возможные исключения

Exception

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


logQueries()source public

logQueries( boolean|null $enable null )

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

Параметры

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

включить или отключить протоколирование. Используйте null для чтения текущего значения.

Возвращает

boolean

logger()source public

logger( object|null $instance null )

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

Параметры

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

Возвращает

object
экземпляр логгера

transactional()source public

transactional( callable $transaction )

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

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

Параметры

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

Возвращает

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

Возможные исключения

Exception

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


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

Spec-Zone.ru

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