Класс SqliteStatement

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

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

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

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

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

Примеры:

$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

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

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

Пример:

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