Spec-Zone.ru › CakePHP 3.6

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

Получить данные конфигурации, используемые для создания подключения.

Возвращает

array

configName()source public

configName( )

Получить имя конфигурации для этого подключения.

Возвращает

string

disableConstraints()source public

disableConstraints( callable $operation )

Выполнить операцию с отключенными ограничениями.

Ограничения следует повторно включить после успешного/неуспешного завершения обратного вызова.

Параметры

callable $operation
Обратный вызов, который необходимо выполнить в рамках транзакции.

Возвращает

mixed
Значение, возвращаемое обратным вызовом.

Выбрасывает

Exception

Перебросит любое исключение, сгенерированное в $callback, после отката транзакции.


logQueries()source public

logQueries( boolean|null $enable = null )

Включить или отключить протоколирование запросов для этого подключения.

Параметры

boolean|null $enable optional null

включить или отключить протоколирование. Используйте null для чтения текущего значения.

Возвращает

boolean

logger()source public deprecated

logger( object|null $instance = null )

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

Устарело

3.5.0 Будет заменено на getLogger()/setLogger()

Параметры

object|null $instance optional null
экземпляр объекта логгера

Возвращает

object
экземпляр логгера

transactional()source public

transactional( callable $transaction )

Выполняет передаваемую функцию внутри транзакции. Если при выполнении передаваемой функции произойдет исключение, транзакция будет отменена. Если результат выполнения функции равен false, транзакция также будет отменена. В противном случае транзакция завершается успешно после выполнения обратного вызова.

Обратный вызов получит экземпляр подключения в качестве первого аргумента.

Параметры

callable $transaction
Обратный вызов, который необходимо выполнить в рамках транзакции.

Возвращает

mixed
Значение, возвращаемое обратным вызовом.

Выбрасывает

Exception

Перебросит любое исключение, сгенерированное в $callback, после отката транзакции.


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

execute()source public

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

Параметры

$query
$params optional
array $types optional

Возвращает

Cake\Database\StatementInterface

getLogger()source public

getLogger( )

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

Возвращает

object

getSchemaCollection()source public

getSchemaCollection( )

Возвращает

Cake\Database\Schema\Collection

newQuery()source public

newQuery( )

Возвращает

Cake\Database\Query

prepare()source public

prepare( $sql )

Параметры

$sql

Возвращает

Cake\Database\StatementInterface

quote()source public

quote( $value , $type = )

Параметры

$value
$type optional

Возвращает

строка

supportsDynamicConstraints()source public

supportsDynamicConstraints( )

Возвращает

boolean

© 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

Spec-Zone.ru

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