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