Класс StatementDecorator

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

Этот класс является лишь декоратором фактической реализации оператора, например, PDOStatement.

Пространство имён: Cake\Database\Statement

Константы

string

FETCH_TYPE_ASSOC
```
'assoc'
```
Используется для обозначения того, что при вызове методов fetch будет возвращён ассоциативный массив в результате.
string

FETCH_TYPE_NUM
```
'num'
```
Используется для обозначения того, что в результате при вызове методов fetch будут возвращены числовые индексы.
string

FETCH_TYPE_OBJ
```
'obj'
```
Используется для обозначения того, что в результате при вызове методов fetch будет возвращён объект stdClass.

Резюме свойств

$_driver protected

Cake\Database\DriverInterface

Ссылка на объект драйвера, связанный с этим оператором.
$_hasExecuted protected

bool

Выполнялся ли этот оператор ранее.
$_statement protected

Cake\Database\StatementInterface

Реализация экземпляра оператора, например, PDOStatement или любая другая пользовательская реализация.
$queryString public @property-read

string

Резюме методов

__construct() public

Конструктор
__get() public

Магический метод получения для возврата $queryString в качестве только для чтения.
bind() public

Привязывает набор значений к объекту оператора с соответствующим типом.
bindValue() public

Присваивает значение позиционной или именованной переменной в подготовленном запросе. Если используются позиционные переменные, необходимо начинать с индекса один; если используются именованные параметры, просто используйте имя в любом порядке.
cast() public

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

Закрывает курсор в базе данных, освобождая все ресурсы и память, выделенные для него. В большинстве случаев вызывать этот метод не нужно, так как он автоматически вызывается после извлечения всех результатов из набора результатов.
columnCount() public

Возвращает количество столбцов, которые будут содержать результаты этого оператора.
count() public

Операторы могут передаваться в качестве аргумента для count() для возвращения количества затронутых строк после последнего выполнения.
errorCode() public

Возвращает код ошибки для последней ошибки, возникшей при выполнении этого оператора.
errorInfo() public

Возвращает информацию об ошибке для последней ошибки, возникшей при выполнении этого оператора.
execute() public

Выполняет оператор, отправляя SQL-запрос в базу данных. Он может необязательно принимать массив или аргументы, которые будут привязаны к переменным запроса. Обратите внимание, что привязка параметров из этого метода не будет выполнять никакого пользовательского преобразования типов, так как это обычно происходит при вызове bindValue.
fetch() public

Возвращает следующую строку набора результатов после выполнения этого оператора. Строки могут извлекаться для хранения столбцов по именам или позициям. Если в наборе результатов нет строк, этот метод возвращает false.
fetchAll() public

Возвращает массив со всеми строками, полученными в результате выполнения этого оператора.
fetchAssoc() public

Возвращает следующую строку в наборе результатов в виде ассоциативного массива. Вызов этой функции эквивалентен вызову $statement->fetch(StatementDecorator::FETCH_TYPE_ASSOC). Если результатов нет, возвращается пустой массив.
fetchColumn() public

Возвращает значение результата в заданной позиции.
getInnerStatement() public

Возвращает объект оператора, который был декорирован этим классом.
getIterator() public

Операторы итерируемы как массивы; этот метод вернёт объект итератора для обхода всех элементов в результате.
lastInsertId() public

Возвращает последний вставленный первичный ключ, используя этот оператор.
matchTypes() public

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

Возвращает количество строк, затронутых этим SQL-оператором.

END_OF_DOCUMENT_MARKER

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

__construct() public

__construct(Cake\Database\StatementInterface $statement, Cake\Database\DriverInterface $driver)

Конструктор

Параметры

Cake\Database\StatementInterface $statement: Реализация оператора, например, PDOStatement.
Cake\Database\DriverInterface $driver: Экземпляр драйвера

__get() public

__get(string $property): string|null

Магический геттер для возвращения $queryString в качестве только для чтения.

Параметры

string $property: внутреннее свойство для получения

Возвращает

string|null

bind() public

bind(array $params, array $types): void

Связывает набор значений с объектом оператора с соответствующим типом.

Параметры

array $params: список значений для привязки
array $types: список типов, которые необходимо использовать, ключи должны соответствовать ключам в $params

Возвращает

void

bindValue() public

bindValue(string|int $column, mixed $value, string|int|null $type = 'string'): void

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

Не разрешается комбинировать позиционные и именованные переменные в одном операторе.

Примеры:

$statement->bindValue(1, 'a title');
$statement->bindValue('active', true, 'boolean');
$statement->bindValue(5, new \DateTime(), 'date');

Параметры

string|int $column: имя или позиция параметра для привязки
mixed $value: Значение для привязки к переменной в запросе
string|int|null $type необязательно: имя настроенного класса Type

Возвращает

void

cast() public

cast(mixed $value, Cake\Database\TypeInterface|string|int $type = 'string'): array

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

Параметры

mixed $value: Значение для преобразования
Cake\Database\TypeInterface|string|int $type необязательно: Имя типа или экземпляр типа для использования.

Возвращает

array

closeCursor() public

closeCursor(): void

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

Возвращает

void

columnCount() public

columnCount(): int

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

Пример:

$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
echo $statement->columnCount(); // outputs 2

Возвращает

int

count() public

count(): int

Операторы могут быть переданы в качестве аргумента для count() для возвращения количества строк, затронутых последним выполнением.

Возвращает

int

errorCode() public

errorCode(): string|int

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

Возвращает

string|int

errorInfo() public

errorInfo(): array

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

Возвращает

array

execute() public

execute(array|null $params = null): bool

Выполняет оператор, отправляя SQL-запрос в базу данных. Он может необязательно принимать массив или аргументы, которые будут привязаны к переменным запроса. Обратите внимание, что привязка параметров из этого метода не выполнит никакого пользовательского преобразования типов, как это обычно происходит при вызове bindValue.

Параметры

array|null $params необязательно: список значений, которые необходимо привязать к запросу

Возвращает

bool

fetch() public

fetch(string|int $type = self::FETCH_TYPE_NUM): mixed

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

Пример:

$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->fetch('assoc')); // will show ['id' => 1, 'title' => 'a title']

Параметры

string|int $type необязательно: 'num' для позиционных столбцов, assoc для именованных столбцов

Возвращает

mixed

fetchAll() public

fetchAll(string|int $type = self::FETCH_TYPE_NUM): array|false

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

Пример:

$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->fetchAll('assoc')); // will show [0 => ['id' => 1, 'title' => 'a title']]

Параметры

string|int $type необязательно: num для извлечения столбцов в качестве позиционных ключей или assoc для имен столбцов в качестве ключей

Возвращает

array|false

fetchAssoc() public

fetchAssoc(): array

Возвращает следующую строку в наборе результатов в виде ассоциативного массива. Вызов этой функции эквивалентен вызову $statement->fetch(StatementDecorator::FETCH_TYPE_ASSOC). Если результатов нет, возвращается пустой массив.

Возвращает

array

fetchColumn() public

fetchColumn(int $position): mixed

Возвращает значение результата в заданной позиции.

Параметры

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

Возвращает

mixed

getInnerStatement() public

getInnerStatement(): Cake\Database\StatementInterface

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

Возвращает

Cake\Database\StatementInterface

getIterator() public

getIterator(): Cake\Database\StatementInterface

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

Пример:

$statement = $connection->prepare('SELECT id, title from articles');
foreach ($statement as $row) {
  //do stuff
}

Возвращает

Cake\Database\StatementInterface

lastInsertId() public

lastInsertId(string|null $table = null, string|null $column = null): string|int

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

Параметры

string|null $table необязательно: имя таблицы или последовательности для получения последнего значения вставки
string|null $column необязательно: имя столбца, представляющего первичный ключ

Возвращает

string|int

matchTypes() public

matchTypes(array $columns, array $types): array

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

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

Параметры

array $columns: список или ассоциативный массив столбцов и параметров, которые необходимо привязать с типами
array $types: список или ассоциативный массив типов

Возвращает

array

rowCount() public

rowCount(): int

Возвращает количество строк, затронутых этим SQL-оператором.

Пример:

$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->rowCount()); // will show 1

Возвращает

int

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

`$_driver` защищенное

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

Тип

Cake\Database\DriverInterface

`$_hasExecuted` защищенное

Выполнялся ли этот оператор ранее

Тип

bool

`$_statement` защищенное

Реализация экземпляра оператора, например, PDOStatement или любая другая кастомная реализация.

Тип

Cake\Database\StatementInterface

`$queryString` общедоступное @property-read

Тип

string

© 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/class-Cake.Database.Statement.StatementDecorator.html