Класс PDOStatement

Декоратор для класса \PDOStatement, в основном используемый для преобразования удобочитаемых режимов извлечения в константы PDO.

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

Константы

string

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

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

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

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

$_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

Назначает значение позиционной или именованной переменной в подготовленном запросе. При использовании позиционных переменных необходимо начинать с индекса один, при использовании именованных параметров используйте просто имя в любом порядке.
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

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

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

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

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

Тип

Cake\Database\DriverInterface

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

Выполнялось ли это утверждение ранее

Тип

bool

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

Экземпляр PDOStatement

Тип

PDOStatement

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