Интерфейс ConnectionInterface
Этот интерфейс определяет методы, на которые вы можете положиться при работе с подключением.
Прямые реализующие
Краткое описание методов
- config() publicПолучить данные конфигурации, используемые для создания подключения.
- configName() publicПолучить имя конфигурации для этого подключения.
- disableConstraints() publicВыполнить операцию с отключёнными ограничениями.
- logQueries() publicВключить или отключить протоколирование запросов для этого подключения.
- logger() public
Устанавливает экземпляр объекта логгера. При вызове без аргументов возвращает текущий установленный экземпляр логгера.
- transactional() public
Выполняет переданную функцию в рамках транзакции. Если во время выполнения переданной функции возникает исключение, транзакция будет откачена. Если результат работы переданной функции равен
false, транзакция также будет откачена. В противном случае транзакция подтверждается после выполнения обратного вызова.
Подробное описание методов
config()source public
config( )
Получить данные конфигурации, используемые для создания подключения.
Возвращает
arrayconfigName()source public
configName( )
Получить имя конфигурации для этого подключения.
Возвращает
stringdisableConstraints()source public
disableConstraints( callable $operation )
Выполнить операцию с отключёнными ограничениями.
Ограничения должны быть повторно включены после успешного/неудачного выполнения обратного вызова.
Параметры
- callable
$operation - Обратный вызов для выполнения в рамках транзакции.
Возвращает
mixedЗначение, возвращаемое обратным вызовом.
Возможные исключения
ExceptionПеребросит любое исключение, возникшее в $callback, после отката транзакции.
logQueries()source public
logQueries( boolean|null $enable null )
Включить или отключить протоколирование запросов для этого подключения.
Параметры
- boolean|null
$enableнеобязательно null включить или отключить протоколирование. Используйте null для чтения текущего значения.
Возвращает
booleanlogger()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