Класс MysqlStatement

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

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

Константы

string

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

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

FETCH_TYPE_OBJ
```
'obj'
```
Используется для обозначения того, что в результате при вызове методов fetch будет возвращён объект 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

Магический геттер для возврата $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). Если результатов нет, возвращается false.
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): mixed

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

Параметры

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

Возвращает

mixed

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(): int|string

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

Возвращает

int|string

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). Если результатов нет, возвращается false.

Возвращает

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.2/class-Cake.Database.Statement.MysqlStatement.html