Spec-Zone.ru › CakePHP 3.8

Интерфейс ConnectionInterface

Этот интерфейс определяет методы, на которых вы можете положиться в соединении.

Прямые реализаторы

  • Cake\Database\Connection
Пространство имён: Cake\Datasource
Расположение: Datasource/ConnectionInterface.php

Краткое описание методов

  • config() public
    Получить данные конфигурации, используемые для создания соединения.
  • configName() public
    Получить имя конфигурации для этого соединения.
  • disableConstraints() public
    Выполнить операцию с отключёнными ограничениями.
  • logQueries() public
    Включает или отключает протоколирование запросов для этого соединения.
  • logger() public deprecated

    Устанавливает экземпляр объекта логгера. При вызове без аргументов возвращает текущий установленный экземпляр логгера.

  • 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, после отката транзакции.


Краткое описание магических методов

execute()source public

execute( $query , $params = , array $types = )

Параметры

$query
$params необязательно
массив $types необязательно

Возвращает

Cake\Database\StatementInterface

getLogger()source public

getLogger( )

Получить текущий экземпляр логгера

Возвращает

объект

getSchemaCollection()source public

getSchemaCollection( )

Возвращает

Cake\Database\Schema\Collection

isQueryLoggingEnabled()source public

isQueryLoggingEnabled( )

Возвращает

булево

newQuery()source public

newQuery( )

Возвращает

Cake\Database\Query

prepare()source public

prepare( $sql )

Параметры

$sql

Возвращает

Cake\Database\StatementInterface

quote()source public

quote( $value , $type = )

Параметры

$value
$type необязательно

Возвращает

строка

supportsDynamicConstraints()source public

supportsDynamicConstraints( )

Возвращает

булево

© 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API