Класс MysqlStatement

Класс-заявление, предназначенный для использования драйвером MySQL PDO

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

Константы

string

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

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

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

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

$_bufferResults protected

bool

Буферизовать ли результаты в PHP
$_driver protected

Cake\Database\DriverInterface

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

bool

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

PDOStatement

Экземпляр PDOStatement
$queryString public @property-read

string

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

__construct() public

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

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

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

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

Буферизовать ли результаты в php
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(PDOStatement $statement, Cake\Database\DriverInterface $driver)

Конструктор

Параметры

PDOStatement $statement: Исходное предложение для обработки.
Cake\Database\DriverInterface $driver: Экземпляр драйвера.

__get() public

__get(string $property): string|null

Магический геттер для возвращения PDOStatement::$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

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

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

Совмещение позиционных и именованных переменных в одном операторе запрещено.

Примеры:

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

Параметры

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

Возвращает

void

bufferResults() public

bufferResults(bool $buffer): $this

Буферизация результатов в PHP.

Параметры

bool $buffer: Включить буферизацию.

Возвращает

$this

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 = parent::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 = parent::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

Подробности свойств

`$_bufferResults` protected

Буферизовать результаты в php

Тип

bool

`$_driver` protected

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

Тип

Cake\Database\DriverInterface

`$_hasExecuted` protected

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

Тип

bool

`$_statement` protected

Экземпляр PDOStatement

Тип

PDOStatement

`$queryString` public @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.MysqlStatement.html