Класс CallbackStatement

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

Используется CakePHP для жадного загрузки данных ассоциаций.

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

Постоянные значения

string

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

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

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

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

$_callback protected

callable

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

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

Преобразует заданное значение в подходящее значение базы данных на основе типа и возвращает соответствующий внутренний тип оператора.
closeCursor() public

Закрывает указатель в базе данных, освобождая все ресурсы и память, выделенные для него. В большинстве случаев вам не нужно вызывать этот метод, так как он автоматически вызывается после извлечения всех результатов из набора результатов.
columnCount() public

Возвращает количество столбцов, которые будут содержать результаты этого оператора.
count() public

Операторы могут передаваться в качестве аргумента для count() для возврата количества затронутых строк от последнего выполнения.
errorCode() public

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

Возвращает информацию об ошибке для последней ошибки, произошедшей при выполнении этого оператора.
execute() public

Выполняет оператор, отправляя SQL-запрос в базу данных. Он может необязательно принимать массив или аргументы, которые должны быть связаны с переменными запроса. Обратите внимание, что привязка параметров из этого метода не будет выполнять никакого пользовательского преобразования типов, как это обычно происходит при вызове bindValue.
fetch() public

Извлекает строку из оператора.
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(Cake\Database\StatementInterface $statement, Cake\Database\DriverInterface $driver, callable $callback)

Конструктор

Параметры

Cake\Database\StatementInterface $statement: Запрос для декорирования.
Cake\Database\DriverInterface $driver: Экземпляр драйвера, используемый запросом.
callable $callback: Обратный вызов, применяемый к результатам перед их возвращением.

__get() public

__get(string $property): string|null

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

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

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

Примеры:

$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

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): array|false

Извлечь строку из запроса.

Результат будет обработан обратным вызовом, если он не false.

Параметры

string|int $type необязательно: Либо 'num', либо 'assoc', чтобы указать желаемый формат результата.

Возвращает

array|false

fetchAll() public

fetchAll(string|int $type = parent::FETCH_TYPE_NUM): array|false

Возвращает массив со всеми строками, полученными в результате выполнения этого запроса.

Каждая строка в результате будет обработана обратным вызовом, если она не равна `false`.

Параметры

string|int $type необязательно

Возвращает

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

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

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

Функция обратного вызова, применяемая к результатам.

Тип

callable

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

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

Тип

Cake\Database\DriverInterface

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

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

Тип

bool

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

Реализация экземпляра оператора, например PDOStatement или любая другая пользовательская реализация.

Тип

Cake\Database\StatementInterface

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