Интерфейс 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 )
Включает или отключает протоколирование запросов для этого соединения.
Параметры
- булево|null
$enableнеобязательно null включить или отключить протоколирование. Используйте null для чтения текущего значения.
Возвращает
булевоlogger()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.8/class-Cake.Datasource.ConnectionInterface.html