Spec-Zone.ru › CakePHP 3.5

Интерфейс ConnectionInterface

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

Непосредственные реализаторы

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

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

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


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

execute()source public

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

Параметры

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

Возвращает

Cake\Database\StatementInterface

getLogger()source public

getLogger( )

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

Возвращает

объект

newQuery()source public

newQuery( )

Возвращает

Cake\Database\Query

prepare()source public

prepare( $sql )

Параметры

$sql

Возвращает

Cake\Database\StatementInterface

quote()source public

quote( $value , $type )

Параметры

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

Возвращает

строка

schemaCollection()source public

schemaCollection( )

Возвращает

Cake\Database\Schema\Collection

supportsDynamicConstraints()source public

supportsDynamicConstraints( )

Возвращает

логический

© 2005–2018 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.5/class-Cake.Datasource.ConnectionInterface.html

Spec-Zone.ru

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