Интерфейс ConnectionInterface
Данный интерфейс определяет методы, на которые можно положиться при работе с подключением.
Непосредственные реализаторы
Краткое описание методов
- 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 )
Устанавливает экземпляр объекта логгера. При вызове без аргументов возвращает текущий установленный экземпляр логгера.
Устарело
3.5.0 Будет заменено на getLogger()/setLogger()Параметры
- объект или 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.4/class-Cake.Datasource.ConnectionInterface.html