Класс Connection

__constructsource public

__construct( array $config )

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

Параметры

массив $config

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

__debugInfosource public

__debugInfo( )

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

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

array
массив

__destructsource public

__destruct( )

Деструктор

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

_newLoggersource protected

_newLogger( Cake\Database\StatementInterface $statement )

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

Параметры

Cake\Database\StatementInterface $statement

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

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

Cake\Database\Log\LoggingStatement
\Cake\Database\Log\LoggingStatement

beginsource public

begin( )

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

cacheMetadatasource public

cacheMetadata( boolean|string $cache )

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

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

Параметры

boolean|string $cache

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

commitsource public

commit( )

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

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

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

compileQuerysource public

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

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

Параметры

Cake\Database\Query $query

Запрос, который нужно скомпилировать

Cake\Database\ValueBinder $generator

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

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

string
строка

configsource public

config( )

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

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

array
массив

Реализация

Cake\Datasource\ConnectionInterface::config()

configNamesource public

configName( )

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

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

string
строка

Реализация

Cake\Datasource\ConnectionInterface::configName()

connectsource public

connect( )

Подключается к базе данных, заданной в конфигурации.

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

boolean
true при успехе или false, если уже подключено.

Вызывает

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

createSavePointsource public

createSavePoint( string $name )

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

Параметры

строка $name

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

deletesource public

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

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

Параметры

строка $table

таблица, из которой удаляются строки

массив $conditions необязательно []

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

массив $types необязательно []

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

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

Cake\Database\StatementInterface
\Cake\Database\StatementInterface

disableConstraintssource public

disableConstraints( callable $callback )

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

Пример:

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

Параметры

обратный вызов $callback

$operation Обратный вызов, который нужно выполнить.

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

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

Вызывает

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

Реализация

Cake\Datasource\ConnectionInterface::disableConstraints()

disableForeignKeyssource public

disableForeignKeys( )

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

disconnectsource public

disconnect( )

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

driversource public

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

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

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

Параметры

Cake\Database\Driver|строка|null $driver необязательно null

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

массив $config необязательно []

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

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

Cake\Database\Driver
\Cake\Database\Driver

Вызывает

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

enableForeignKeyssource public

enableForeignKeys( )

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

executesource public

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

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

Параметры

строка $query

SQL-запрос для выполнения и интерполяции с помощью $params

массив $params необязательно []

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

массив $types необязательно []

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

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

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

inTransactionsource public

inTransaction( )

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

Возвращает

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

insertsource public

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

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

Параметры

строка $table

таблица, в которую нужно вставить значения

массив $data

значения, которые нужно вставить

массив $types необязательно []

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

Возвращает

Cake\Database\StatementInterface
\Cake\Database\StatementInterface

isConnectedsource public

isConnected( )

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

Возвращает

boolean
bool

logsource public

log( string $sql )

Регистрирует строку запроса с помощью объекта зарегистрированного логгера.

Параметры

строка $sql

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

logQueriessource public

logQueries( boolean $enable null )

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

Параметры

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

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

Возвращает

boolean
bool

Реализация

Cake\Datasource\ConnectionInterface::logQueries()

loggersource public

logger( object $instance null )

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

Параметры

объект $instance необязательно null

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

Возвращает

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

Реализация

Cake\Datasource\ConnectionInterface::logger()

newQuerysource public

newQuery( )

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

Возвращает

Cake\Database\Query
\Cake\Database\Query

preparesource public

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

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

Параметры

строка|Cake\Database\Query $sql

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

Возвращает

Cake\Database\StatementInterface
\Cake\Database\StatementInterface

querysource public

query( string $sql )

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

Параметры

строка $sql

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

Возвращает

Cake\Database\StatementInterface
\Cake\Database\StatementInterface

quotesource public

quote( mixed $value , string $type null )

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

Параметры

смешанное $value

Значение для приведения к нужному виду.

строка $type необязательно null

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

Возвращает

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

quoteIdentifiersource public

quoteIdentifier( string $identifier )

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

Параметры

строка $identifier

Идентификатор для приведения к нужному виду.

Возвращает

string
строка

releaseSavePointsource public

releaseSavePoint( string $name )

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

Параметры

строка $name

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

rollbacksource public

rollback( )

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

Возвращает

boolean
bool

rollbackSavepointsource public

rollbackSavepoint( string $name )

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

Параметры

строка $name

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

runsource public

run( Cake\Database\Query $query )

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

Параметры

Cake\Database\Query $query

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

Возвращает

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

schemaCollectionsource public

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

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

Параметры

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

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

Возвращает

Cake\Database\Schema\Collection
\Cake\Database\Schema\Collection

supportsDynamicConstraintssource public

supportsDynamicConstraints( )

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

Возвращает

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

supportsQuotingsource public

supportsQuoting( )

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

Возвращает

boolean
bool

transactionalsource public

transactional( callable $callback )

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

Пример:

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

Параметры

обратный вызов $callback

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

Возвращает

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

Исключения

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

Реализация

Cake\Datasource\ConnectionInterface::transactional()

updatesource public

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

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

Параметры

string $table

таблица, из которой необходимо обновить строки

array $data

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

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

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

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

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

Возвращает

Cake\Database\StatementInterface
Cake\Database\StatementInterface

useSavePointssource public

useSavePoints( boolean|null $enable null )

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

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

Пример:

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

Параметры

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

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

Возвращает

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

castsource public

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

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

Параметры

mixed $value

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

Cake\Database\Type|string $type

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

Возвращает

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

matchTypessource public

matchTypes( array $columns , array $types )

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

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

Параметры

array $columns

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

array $types

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

Возвращает

array
массив

false

null

false

false