Класс Connection

__construct()source public

__construct( array $config )

Конструктор.

Параметры

массив $config

конфигурация для подключения к базе данных

__debugInfo()source public

__debugInfo( )

Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.

Возвращает

массив

__destruct()source public

__destruct( )

Деструктор

Отключает драйвер, чтобы освободить соединение.

_newLogger()source protected

_newLogger( Cake\Database\StatementInterface $statement )

Возвращает новый объект инструкции, который будет регистрировать действия для переданного исходного экземпляра инструкции.

Параметры

Cake\Database\StatementInterface $statement

экземпляр, который нужно декорировать

Возвращает

Cake\Database\Log\LoggingStatement

begin()source public

begin( )

Начинает новую транзакцию.

cacheMetadata()source public

cacheMetadata( boolean|string $cache )

Включает или отключает кеширование метаданных для этого соединения

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

Параметры

boolean|string $cache

Либо boolean false для отключения кеширования метаданных, либо true для использования _cake_model_ или имя конфигурации кеша для использования.

commit()source public

commit( )

Подтверждает текущую транзакцию.

Возвращает

boolean
true при успехе, false в противном случае

compileQuery()source public

compileQuery( Cake\Database\Query $query , Cake\Database\ValueBinder $generator )

Компилирует объект Query в строку SQL в соответствии с диалектом для драйвера этого соединения

Параметры

Cake\Database\Query $query

Запрос для компиляции

Cake\Database\ValueBinder $generator

Генератор заменителей для использования

Возвращает

string

config()source public

config( )

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

Возвращает

array

Реализация

Cake\Datasource\ConnectionInterface::config()

configName()source public

configName( )

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

Возвращает

string

Реализация

Cake\Datasource\ConnectionInterface::configName()

connect()source public

connect( )

Подключается к базе данных, настроенной по умолчанию.

Возвращает

boolean
true, если соединение уже установлено или попытка успешна.

Выбрасывает

Cake\Database\Exception\MissingConnectionException
если учетные данные неверны.

createSavePoint()source public

createSavePoint( string $name )

Создает новую точку сохранения для вложенных транзакций.

Параметры

string $name

Имя точки сохранения.

delete()source public

delete( string $table , array $conditions [] , array $types [] )

Выполняет операцию DELETE для указанной таблицы.

Параметры

string $table

таблица для удаления строк

array $conditions optional []

условия для оператора DELETE

array $types optional []

список ассоциативных массивов, содержащих типы для преобразования

Возвращает

Cake\Database\StatementInterface

disableConstraints()source public

disableConstraints( callable $callback )

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

Пример:

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

Параметры

callable $callback

$operation Обратный вызов для выполнения внутри транзакции.

Возвращает

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

Выбрасывает

Exception

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

Реализация

Cake\Datasource\ConnectionInterface::disableConstraints()

disableForeignKeys()source public

disableForeignKeys( )

Выполняет драйвер-специфический SQL для отключения проверки внешних ключей.

disconnect()source public

disconnect( )

Отключается от сервера базы данных.

driver()source public

driver( Cake\Database\Driver|string|null $driver null , array $config [] )

Устанавливает экземпляр драйвера. Если передана строка, она будет обработана как имя класса и будет создана.

Если параметры не переданы, возвращается текущий экземпляр драйвера.

Устарело

3.4.0 Используйте setDriver()/getDriver() вместо этого.

Параметры

Cake\Database\Driver|string|null $driver optional null

Экземпляр драйвера для использования.

array $config optional []

либо конфигурация для нового драйвера, либо null.

Возвращает

Cake\Database\Driver

Выбрасывает

Cake\Database\Exception\MissingDriverException
При отсутствии класса драйвера.
Cake\Database\Exception\MissingExtensionException
При отсутствии PHP расширения драйвера.

enableForeignKeys()source public

enableForeignKeys( )

Выполняет драйвер-специфический SQL для включения проверки внешних ключей.

enableSavePoints()source public

enableSavePoints( boolean $enable )

Включает/выключает использование точек сохранения, включает только если это позволяет драйвер.

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

Пример:

$connection->enableSavePoints(true) Возвращает true, если драйвер поддерживает точки сохранения, в противном случае false $connection->enableSavePoints(false) Отключает использование точек сохранения и возвращает false

Параметры

boolean $enable

Используются ли точки сохранения.

Возвращает

$this

execute()source public

execute( string $query , array $params [] , array $types [] )

Выполняет запрос, используя $params для интерполяции значений и $types как подсказку для каждого из этих параметров.

Параметры

string $query

SQL для выполнения и интерполяции с $params

array $params optional []

список или ассоциативный массив параметров, которые будут интерполированы в $query в качестве значений

array $types optional []

список или ассоциативный массив типов, которые будут использоваться для преобразования значений в запросе

Возвращает

Cake\Database\StatementInterface
выполненная инструкция

getDriver()source public

getDriver( )

Получает экземпляр драйвера.

Возвращает

Cake\Database\Driver

getLogger()source public

getLogger( )

Получает объект регистратора

Возвращает

Cake\Database\Log\QueryLogger
экземпляр регистратора

getSchemaCollection()source public

getSchemaCollection( )

Получает объект Schema\Collection для этого соединения.

Возвращает

Cake\Database\Schema\Collection

inTransaction()source public

inTransaction( )

Проверяет, выполняется ли транзакция.

Возвращает

boolean
True, если транзакция выполняется, иначе false.

insert()source public

insert( string $table , array $data , array $types [] )

Выполняет запрос INSERT для указанной таблицы.

Параметры

string $table

таблица для вставки значений

array $data

значения для вставки

array $types необязательно []

список ассоциативных массивов, содержащих типы для преобразования

Возвращает

Cake\Database\StatementInterface

isConnected()source public

isConnected( )

Возвращает, было ли установлено соединение с сервером базы данных.

Возвращает

boolean

isSavePointsEnabled()source public

isSavePointsEnabled( )

Возвращает, использует ли это соединение сохраняемые точки для вложенных транзакций

Возвращает

boolean
true, если включено, false — иначе

log()source public

log( string $sql )

Записывает строку запроса с помощью объекта логгера, настроенного в конфигурации.

Параметры

string $sql

строка, которая должна быть записана в лог

logQueries()source public

logQueries( boolean|null $enable null )

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

Параметры

boolean|null $enable необязательно null

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

Возвращает

boolean

Реализация

Cake\Datasource\ConnectionInterface::logQueries()

logger()source public

logger( object|null $instance null )

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

Устарело

3.5.0 Используйте getLogger() и setLogger() вместо этого.

Параметры

object|null $instance необязательно null

экземпляр объекта логгера

Возвращает

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

Реализация

Cake\Datasource\ConnectionInterface::logger()

newQuery()source public

newQuery( )

Создает новый экземпляр Query для этого соединения.

Возвращает

Cake\Database\Query

prepare()source public

prepare( string|Cake\Database\Query $sql )

Подготавливает SQL-запрос для выполнения.

Параметры

string|Cake\Database\Query $sql

SQL, который нужно преобразовать в подготовленный запрос.

Возвращает

Cake\Database\StatementInterface

query()source public

query( string $sql )

Выполняет SQL-запрос и возвращает объект Statement в качестве результата.

Параметры

string $sql

SQL-запрос для выполнения.

Возвращает

Cake\Database\StatementInterface

quote()source public

quote( mixed $value , string|null $type null )

Приводит значение к виду, безопасному для использования в запросе к базе данных.

Параметры

mixed $value

Значение, которое нужно привести к виду, безопасному для использования в запросе.

string|null $type необязательно null

Тип, используемый для определения вида приведения

Возвращает

string
Приведенное значение

quoteIdentifier()source public

quoteIdentifier( string $identifier )

Приводит идентификатор базы данных (имя столбца, имя таблицы и т. д.) к виду, безопасному для использования в запросах без риска использования зарезервированных слов.

Параметры

string $identifier

Идентификатор для приведения к виду, безопасному для использования в запросе.

Возвращает

string

releaseSavePoint()source public

releaseSavePoint( string $name )

Освобождает сохраняемую точку по её имени.

Параметры

string $name

Имя сохраняемой точки.

rollback()source public

rollback( boolean|null $toBeginning null )

Откатывает текущую транзакцию.

Параметры

boolean|null $toBeginning необязательно null

Определяет, откатывать ли транзакцию в начало. По умолчанию false, если используются сохраняемые точки, или true, если нет.

Возвращает

boolean

rollbackSavepoint()source public

rollbackSavepoint( string $name )

Откатывает сохраняемую точку по её имени.

Параметры

string $name

Имя сохраняемой точки.

run()source public

run( Cake\Database\Query $query )

Выполняет предоставленный запрос после его компиляции для конкретного диалекта драйвера и возвращает объект Statement, который был выполнен.

Параметры

Cake\Database\Query $query

Запрос для выполнения

Возвращает

Cake\Database\StatementInterface
выполненный запрос

schemaCollection()source public

schemaCollection( Cake\Database\Schema\Collection $collection null )

Получает или устанавливает объект Schema\Collection для этого соединения.

Устарело

3.4.0 Используйте setSchemaCollection()/getSchemaCollection()

Параметры

Cake\Database\Schema\Collection $collection необязательно null

объект схемы

Возвращает

Cake\Database\Schema\Collection

setDriver()source public

setDriver( Cake\Database\Driver|string $driver , array $config [] )

Устанавливает экземпляр драйвера. Если передано строковое значение, оно будет интерпретировано как имя класса и будет создан экземпляр.

Параметры

Cake\Database\Driver|string $driver

Экземпляр драйвера для использования.

array $config необязательно []

Настройки для нового драйвера.

Возвращает

$this

Исключения

Cake\Database\Exception\MissingDriverException
При отсутствии класса драйвера.
Cake\Database\Exception\MissingExtensionException
При отсутствии PHP-расширения драйвера.

setLogger()source public

setLogger( Cake\Database\Log\QueryLogger $logger )

Устанавливает логгер.

Параметры

Cake\Database\Log\QueryLogger $logger

Объект логгера

Возвращает

$this

setSchemaCollection()source public

setSchemaCollection( Cake\Database\Schema\Collection $collection )

Устанавливает объект Schema\Collection для этого подключения.

Параметры

Cake\Database\Schema\Collection $collection

Объект схемы коллекций

Возвращаемое значение

$this

supportsDynamicConstraints()source public

supportsDynamicConstraints( )

Возвращает, поддерживает ли драйвер добавление или удаление ограничений к уже созданным таблицам.

Возвращаемое значение

boolean
true, если драйвер поддерживает динамические ограничения

supportsQuoting()source public

supportsQuoting( )

Проверяет, поддерживает ли драйвер цитирование.

Возвращаемое значение

boolean

transactional()source public

transactional( callable $callback )

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

Пример:

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

Параметры

callable $callback

$transaction Обратный вызов для выполнения внутри транзакции.

Возвращаемое значение

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

Исключения

Exception

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

Реализация

Cake\Datasource\ConnectionInterface::transactional()

update()source public

update( string $table , array $data , array $conditions [] , array $types [] )

Выполняет оператор UPDATE для указанной таблицы.

Параметры

string $table

таблица, для которой обновляются строки

array $data

значения для обновления

array $conditions необязательно []

условия для оператора обновления

array $types необязательно []

список ассоциативных массивов, содержащих типы, которые будут использоваться для преобразования типов

Возвращаемое значение

Cake\Database\StatementInterface

useSavePoints()source public

useSavePoints( boolean|null $enable null )

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

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

Пример:

$connection->useSavePoints(true) Возвращает true, если драйвер поддерживает сохранение точек, false в противном случае $connection->useSavePoints(false) Отключает использование сохранения точек и возвращает false $connection->useSavePoints() Возвращает текущий статус

Устарело

3.4.0 Используйте enableSavePoints()/isSavePointsEnabled() вместо этого.

Параметры

boolean|null $enable необязательно null

Использовать или не использовать сохранение точек.

Возвращаемое значение

boolean
true, если включено, false в противном случае

wasNestedTransactionRolledback()source protected

wasNestedTransactionRolledback( )

Возвращает, была ли уже отменена какая-либо вложенная транзакция.

Возвращаемое значение

boolean

cast()source public

cast( mixed $value , Cake\Database\Type|string $type )

Преобразует заданное значение в соответствующее значение базы данных на основе типа и возвращает соответствующий внутренний тип оператора.

Параметры

mixed $value

Значение для преобразования

Cake\Database\Type|string $type

Имя типа или экземпляр типа для использования.

Возвращаемое значение

array
Список, содержащий преобразованное значение и внутренний тип

matchTypes()source public

matchTypes( array $columns , array $types )

Сопоставляет столбцы соответствующим типам

Как $columns, так и $types должны быть либо числовыми, либо строковыми ключами одновременно.

Параметры

array $columns

список или ассоциативный массив столбцов и параметров, которые нужно связать с типами

array $types

список или ассоциативный массив типов

Возвращаемое значение

array

false

false

false