Класс SqliteStatement

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

Пространство имён: 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

Cake\Database\StatementInterface

Реализация экземпляра оператора, например, 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). Если результаты не найдены, возвращается пустой массив.
fetchColumn() public

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

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

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

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

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

Возвращает количество возвращённых строк, затронутых последним выполнением

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 в качестве read-only.

Параметры

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 необязательно: имя сконфигурированного класса типа

Возвращает

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

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

Пример:

$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 или любая другая пользовательская реализация.

Тип

Cake\Database\StatementInterface

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