Класс BufferedStatement
Декоратор оператора, реализующий буферизацию результатов.
Этот декоратор оператора сохранит полученные результаты в памяти, что позволит перемотать и повторно использовать итератор.
- Cake\Database\Statement\StatementDecorator implements Cake\Database\StatementInterface, Countable, IteratorAggregate uses Cake\Database\TypeConverterTrait
-
Cake\Database\Statement\BufferedStatement
Унаследованные константы
Резюме свойств
-
$_allFetchedprotectedЕсли истинно, все строки были извлеченыboolean -
$_countprotectedКоличество записейinteger -
$_counterprotectedТекущий указатель записиinteger -
$_recordsprotectedМассив результатовarray
Унаследованные магические свойства
Унаследованные свойства
Резюме методов
- _reset() protectedСбросить все свойства
- execute() publicВыполнить оператор и вернуть результаты.
- fetch() public
Возвращает следующую строку набора результатов после выполнения этого оператора. Строки могут быть получены для хранения столбцов как по имени, так и по позиции. Если строк больше нет в наборе результатов, этот метод вернёт false.
- fetchAll() publicВозвращает массив со всеми строками, полученными в результате выполнения этого оператора.
- fetchAssoc() public
Возвращает следующую строку в наборе результатов в виде ассоциативного массива. Вызов этой функции эквивалентен вызову $statement->fetch(StatementDecorator::FETCH_TYPE_ASSOC). Если результатов нет, возвращается false.
- rewind() publicПеремотать свойство _counter
- rowCount() publicВозвращает количество строк, затронутых этим оператором SQL.
Подробное описание методов
execute()source public
execute( array|null $params = null )
Выполнить оператор и вернуть результаты.
Параметры
- массив|null
$paramsнеобязательно null - список значений, которые будут привязаны к запросу
Возвращает
booleantrue при успехе, иначе false
Переопределяет
Cake\Database\Statement\StatementDecorator::execute() fetch()source public
fetch( string $type = parent::FETCH_TYPE_NUM )
Возвращает следующую строку набора результатов после выполнения этого оператора. Строки могут быть получены для хранения столбцов как по имени, так и по позиции. Если строк больше нет в наборе результатов, этот метод вернёт false.
Параметры
- строка
$typeнеобязательно parent::FETCH_TYPE_NUM - Тип для извлечения.
Возвращает
массив|falseПереопределяет
Cake\Database\Statement\StatementDecorator::fetch() fetchAll()source public
fetchAll( string $type = parent::FETCH_TYPE_NUM )
Возвращает массив со всеми строками, полученными в результате выполнения этого оператора.
Параметры
- строка
$typeнеобязательно parent::FETCH_TYPE_NUM - Тип для извлечения.
Возвращает
массивПереопределяет
Cake\Database\Statement\StatementDecorator::fetchAll() fetchAssoc()source public
fetchAssoc( )
Возвращает следующую строку в наборе результатов в виде ассоциативного массива. Вызов этой функции эквивалентен вызову $statement->fetch(StatementDecorator::FETCH_TYPE_ASSOC). Если результатов нет, возвращается false.
Возвращает
массив|falseМассив результатов, содержащий столбцы и значения в виде ассоциативного массива или false, если результатов нет
Переопределяет
Cake\Database\Statement\StatementDecorator::fetchAssoc() rowCount()source public
rowCount( )
Возвращает количество строк, затронутых этим оператором SQL.
Возвращает
целое числоПереопределяет
Cake\Database\Statement\StatementDecorator::rowCount() Методы, унаследованные от Cake\Database\Statement\StatementDecorator
__construct()source public
__construct( Cake\Database\StatementInterface|PDOStatement|null $statement = null , Cake\Database\Driver|null $driver = null )
Конструктор
Параметры
-
Cake\Database\StatementInterface|PDOStatement|null$statementнеобязательно null - Реализация оператора, например PDOStatement
-
Cake\Database\Driver|null$driverнеобязательно null - Экземпляр драйвера
__get()source public
__get( string $property )
Магический геттер для возвращения $queryString в качестве только для чтения.
Параметры
- строка
$property - внутреннее свойство для получения
Возвращает
смешанноеbind()source public
bind( array $params , array $types )
Привязывает набор значений к объекту оператора с соответствующим типом.
Параметры
- массив
$params - список значений для привязки
- массив
$types - список типов, которые должны быть использованы, ключи должны совпадать с ключами в $params
Реализация
Cake\Database\StatementInterface::bind() bindValue()source public
bindValue( string|integer $column , mixed $value , string $type = 'string' )
Назначает значение позиционной или именованной переменной в подготовленном запросе. Если используются позиционные переменные, нужно начинать с индекса один, если используются именованные параметры, используйте просто имя в любом порядке.
Не разрешается комбинировать позиционные и именованные переменные в одном операторе.
Примеры:
$statement->bindValue(1, 'a title');
$statement->bindValue('active', true, 'boolean');
$statement->bindValue(5, new \DateTime(), 'date'); Параметры
- строка|целое число
$column - имя или позиция параметра, которые должны быть привязаны
- смешанное
$value - значение, которое нужно привязать к переменной в запросе
- строка
$typeнеобязательно 'string' - имя настроенного класса Type
Реализация
Cake\Database\StatementInterface::bindValue() closeCursor()source public
closeCursor( )
Закрывает указатель в базе данных, освобождая все ресурсы и память, выделенные для него. В большинстве случаев вызывать этот метод не нужно, так как он автоматически вызывается после извлечения всех результатов из набора результатов.
Реализация
Cake\Database\StatementInterface::closeCursor() columnCount()source public
columnCount( )
Возвращает количество столбцов, которые будут содержать результаты этого оператора.
Пример:
$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
echo $statement->columnCount(); // outputs 2 Возвращает
целое числоРеализация
Cake\Database\StatementInterface::columnCount() count()source public
count( )
Операторы могут передаваться в качестве аргумента для count(), чтобы вернуть количество затронутых строк из последнего выполнения.
Возвращает
целое числоРеализация
Cake\Database\StatementInterface::count() errorCode()source public
errorCode( )
Возвращает код ошибки для последней ошибки, которая произошла при выполнении этого оператора.
Возвращает
целое число/строкаРеализация
Cake\Database\StatementInterface::errorCode() errorInfo()source public
errorInfo( )
Возвращает информацию об ошибке для последней ошибки, которая произошла при выполнении этого оператора.
Возвращает
массивРеализация
Cake\Database\StatementInterface::errorInfo() fetchColumn()source public
fetchColumn( integer $position )
Возвращает значение результата в указанной позиции.
Параметры
- целое число
$position - Числовая позиция столбца для извлечения в результате
Возвращает
смешанный/ложьВозвращает конкретное значение столбца, указанного в $position
getInnerStatement()source public
getInnerStatement( )
Возвращает объект оператора, который был украшен этим классом.
Возвращает
Cake\Database\StatementInterface|PDOStatementgetIterator()source public
getIterator( )
Операторы итерируемы как массивы, этот метод вернёт объект итератора для обхода всех элементов в результате.
Пример:
$statement = $connection->prepare('SELECT id, title from articles');
foreach ($statement as $row) {
//do stuff
} Возвращает
Cake\Database\StatementInterface|PDOStatementРеализация
IteratorAggregate::getIterator() lastInsertId()source public
lastInsertId( string|null $table = null , string|null $column = null )
Возвращает последний вставленный первичный ключ, используемый этим оператором.
Параметры
- строка|null
$tableнеобязательно null - имя таблицы или последовательности для получения последнего значения вставки
- строка|null
$columnнеобязательно null - имя столбца, представляющего первичный ключ
Возвращает
строка|целое числоРеализация
Cake\Database\StatementInterface::lastInsertId() Методы, используемые из Cake\Database\TypeConverterTrait
cast()source public
cast( mixed $value , Cake\Database\Type|string $type )
Преобразует заданное значение в подходящее значение базы данных в зависимости от типа и возвращает соответствующий внутренний тип оператора
Параметры
- смешанный
$value - Значение для преобразования
-
Cake\Database\Type|строка$type - Имя типа или экземпляр типа для использования.
Возвращает
массивСписок, содержащий преобразованное значение и внутренний тип
matchTypes()source public
matchTypes( array $columns , array $types )
Сопоставляет столбцы с соответствующими типами
И $columns, и $types должны быть либо числовыми, либо строковыми ключами одновременно.
Параметры
- массив
$columns - список или ассоциативный массив столбцов и параметров, которые будут связаны с типами
- массив
$types - список или ассоциативный массив типов
Возвращает
массивПодробности свойств
© 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/3.6/class-Cake.Database.Statement.BufferedStatement.html