Spec-Zone.ru › CakePHP 3.4

Интерфейс 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( )

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

Возвращает

объект

lastInsertId()source public

lastInsertId( $table , $column )

Параметры

$table необязательно
$column необязательно

Возвращает

строка или целое число

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–2017 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.4/class-Cake.Datasource.ConnectionInterface.html

Spec-Zone.ru

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