Интерфейс ConnectionInterface
Этот интерфейс определяет методы, на которые можно положиться при подключении.
Прямые реализаторы
Краткое описание методов
- config() publicПолучить данные конфигурации, используемые для создания подключения.
- configName() publicПолучить имя конфигурации для этого подключения.
- disableConstraints() publicВыполнить операцию с отключенными ограничениями.
- logQueries() 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 )
Включает или отключает логирование запросов для этого подключения.
Параметры
- boolean|null
$enableнеобязательно null включить или отключить логирование. Использовать null для считывания текущего значения.
Возвращает
booleanlogger()source public deprecated
logger( object|null $instance = null )
Устанавливает экземпляр объекта логгера. При вызове без аргументов возвращает текущий установленный экземпляр логгера.
Устарело
3.5.0 Будет заменено на getLogger()/setLogger()Параметры
- объект|null
$instanceнеобязательно null - экземпляр объекта логгера
Возвращает
объектэкземпляр логгера
transactional()source public
transactional( callable $transaction )
Выполняет передаваемую лямбда-функцию внутри транзакции. Если во время выполнения лямбда-функции возникает исключение, транзакция будет отменена. Если результатом выполнения лямбда-функции является false, транзакция также будет отменена. В противном случае транзакция подтверждается после выполнения обратного вызова.
Обратный вызов получит экземпляр подключения в качестве первого аргумента.
Параметры
- лямбда-функция
$transaction - Обратный вызов, который нужно выполнить внутри транзакции.
Возвращает
смешанное значениеВозвращаемое значение обратного вызова.
Исключения
ИсключениеПеребросит любое исключение, возникшее в $callback, после отмены транзакции.
Краткое описание магических методов
© 2005–present 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.7/class-Cake.Datasource.ConnectionInterface.html