Интерфейс ConnectionInterface

Данный интерфейс определяет методы, на которые можно положиться при работе с подключением.

Пространство имен: Cake\Datasource

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

config() public

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

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

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

Отключить логирование запросов
enableQueryLogging() public

Включить/отключить логирование запросов
execute() public @method

Выполняет запрос, используя $params для интерполяции значений и $types в качестве подсказки для каждого из этих параметров. {@see \Cake\Database\Connnection::execute()}
getCacher() public

Получить кешер.
getDriver() public @method

Получить экземпляр драйвера. {@see \Cake\Database\Connnection::getDriver()}
getLogger() public

Получить текущий объект логгера.
getSchemaCollection() public @method

Получить объект Schema\Collection для данного подключения. {@see \Cake\Database\Connnection::getSchemaCollection()}
isQueryLoggingEnabled() public

Проверить, включено ли логирование запросов.
newQuery() public @method

Создать новый экземпляр Query для данного подключения. {@see \Cake\Database\Connnection::newQuery()}
prepare() public @method

Подготовить SQL-запрос к выполнению. {@see \Cake\Database\Connnection::prepare()}
query() public @method

Выполнить SQL-запрос и вернуть объект Statement в качестве результата. {@see \Cake\Database\Connnection::query()}
setCacher() public

Установить кешер.
setLogger() public @method

Установить текущий логгер. {@see \Cake\Database\Connnection::setLogger()}
supportsDynamicConstraints() public @method

Возвращает, поддерживает ли драйвер добавление или удаление ограничений для уже созданных таблиц. {@see \Cake\Database\Connnection::supportsDynamicConstraints()}
transactional() public

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

Подробное описание методов

config() public

config(): array<string, mixed>

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

Возвращает

array<string, mixed>

configName() public

configName(): string

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

Возвращает

string

disableConstraints() public

disableConstraints(callable $callback): mixed

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

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

Пример:

$connection->disableConstraints(function ($connection) {
  $connection->newQuery()->delete('users')->execute();
});

Параметры

callable $callback: Обратный вызов для выполнения в рамках транзакции.

Возвращает

mixed

Исключения

Exception
Будет повторно выброшено любое исключение, поднятое в $callback, после отката транзакции.

disableQueryLogging() public

disableQueryLogging(): $this

Отключить логирование запросов

Возвращает

$this

enableQueryLogging() public

enableQueryLogging(bool $enable = true): $this

Включить/отключить логирование запросов

Параметры

bool $enable необязательно: Включить/отключить логирование запросов

Возвращает

$this

execute() public @method

execute(mixed $query, mixed $params = [], array $types = []): Cake\Database\StatementInterface

Выполняет запрос, используя $params для интерполяции значений и $types как подсказки для каждого из этих параметров. {@see \Cake\Database\Connnection::execute()}

Параметры

$query
$params необязательно
array $types необязательно

Возвращает

Cake\Database\StatementInterface

getCacher() public

getCacher(): Psr\SimpleCache\CacheInterface

Получить кешер.

Возвращает

Psr\SimpleCache\CacheInterface

getDriver() public @method

getDriver(): object

Получить экземпляр драйвера. {@see \Cake\Database\Connnection::getDriver()}

Возвращает

object

getLogger() public

getLogger(): Psr\Log\LoggerInterface

Получить текущий объект логгера.

Возвращает

Psr\Log\LoggerInterface

getSchemaCollection() public @method

getSchemaCollection(): Cake\Database\Schema\Collection

Получить объект Schema\Collection для этого подключения. {@see \Cake\Database\Connnection::getSchemaCollection()}

Возвращает

Cake\Database\Schema\Collection

isQueryLoggingEnabled() public

isQueryLoggingEnabled(): bool

Проверить, включено ли логирование запросов.

Возвращает

bool

newQuery() public @method

newQuery(): Cake\Database\Query

Создать новый экземпляр Query для этого подключения. {@see \Cake\Database\Connnection::newQuery()}

Возвращает

Cake\Database\Query

prepare() public @method

prepare(mixed $sql): Cake\Database\StatementInterface

Подготавливает SQL-запрос для выполнения. {@see \Cake\Database\Connnection::prepare()}

Параметры

$sql

Возвращает

Cake\Database\StatementInterface

query() public @method

query(string $sql): Cake\Database\StatementInterface

Выполняет SQL-запрос и возвращает объект Statement в качестве результата. {@see \Cake\Database\Connnection::query()}

Параметры

string $sql

Возвращает

Cake\Database\StatementInterface

setCacher() public

setCacher(Psr\SimpleCache\CacheInterface $cacher): $this

Установить кешер.

Параметры

Psr\SimpleCache\CacheInterface $cacher: Объект кешера

Возвращает

$this

setLogger() public @method

setLogger(LoggerInterface $logger): void

Установить текущий логгер. {@see \Cake\Database\Connnection::setLogger()}

Параметры

LoggerInterface $logger

Возвращает

void

supportsDynamicConstraints() public @method

supportsDynamicConstraints(): bool

Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам. {@see \Cake\Database\Connnection::supportsDynamicConstraints()}

Возвращает

bool

transactional() public

transactional(callable $callback): mixed

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

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

Пример:

$connection->transactional(function ($connection) {
  $connection->newQuery()->delete('users')->execute();
});

Параметры

callable $callback: Обратный вызов для выполнения в рамках транзакции.

Возвращает

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/4.4/interface-Cake.Datasource.ConnectionInterface.html