Класс BufferedStatement
Декоратор оператора, реализующий буферизацию результатов.
Этот декоратор оператора сохранит полученные результаты в памяти, позволяя итератору перематываться и повторно использоваться.
- Cake\Database\Statement\BufferedStatement реализует Iterator, Cake\Database\StatementInterface использует Cake\Database\TypeConverterTrait
Наследованные константы
Резюме свойств
-
$_allFetchedprotectedЕсли true, все строки были полученыboolean - Драйвер для оператора
$_driverprotected -
$_hasExecutedprotectedВыполнен ли этот операторboolean -
$bufferprotectedКэш в памяти, содержащий результаты предыдущих итераторовarray -
$indexprotectedТекущий индекс итератора.integer - Декорированный оператор
$statementprotected
Резюме методов
- __construct() publicКонструктор
- __get() publicМагический геттер для возвращения $queryString в качестве только для чтения.
- _reset() protectedСбросить все свойства
- bind() publicСвязывает набор значений с объектом оператора с соответствующим типом
- bindValue() public
Присваивает значение позиционной или именованной переменной в подготовленном запросе. Если вы используете позиционные переменные, вам нужно начать с индекса один, если вы используете именованные параметры, то просто используйте имя в любом порядке.
- closeCursor() public
Закрывает курсор в базе данных, освобождая все ресурсы и память, выделенные для него. В большинстве случаев вам не нужно вызывать этот метод, так как он автоматически вызывается после извлечения всех результатов из набора результатов.
- columnCount() publicВозвращает количество столбцов, которые будут содержать результаты этого оператора
- count() public
Операторы могут быть переданы в качестве аргумента для count() для возврата количества затронутых строк после последнего выполнения.
- current() publicВозвращает текущую запись в итераторе
- errorCode() publicВозвращает код ошибки для последней ошибки, произошедшей при выполнении этого оператора
- errorInfo() public
Возвращает информацию об ошибке для последней ошибки, произошедшей при выполнении этого оператора
- execute() public
Выполняет оператор, отправляя SQL-запрос в базу данных. Он может необязательно принимать массив или аргументы, которые будут привязаны к переменным запроса. Обратите внимание, что привязка параметров из этого метода не будет выполнять никакой пользовательской конвертации типов, как это обычно происходит при вызове
bindValue - fetch() public
Возвращает следующую строку для набора результатов после выполнения этого оператора. Строки могут быть извлечены для содержащих столбцы как имена или позиции. Если в наборе результатов не осталось строк, этот метод вернет false
- fetchAll() publicВозвращает массив со всеми строками, полученными в результате выполнения этого оператора
- fetchAssoc() public
- fetchColumn() public
- getInnerStatement() publicПолучить обернутый оператор
- key() publicВозвращает текущий ключ в итераторе
- lastInsertId() publicВозвращает последнюю вставленную первичную с помощью этого оператора
- next() publicПеремещает указатель итератора к следующему элементу
- rewind() publicПерематывает коллекцию
- rowCount() publicВозвращает количество строк, затронутых этим SQL-оператором
- valid() publicВозвращает, есть ли у итератора больше элементов
Подробное описание методов
__construct()source public
__construct( Cake\Database\StatementInterface $statement , Cake\Database\Driver $driver )
Конструктор
Параметры
-
Cake\Database\StatementInterface$statement - Реализация оператора, например PDOStatement
-
Cake\Database\Driver$driver - Экземпляр драйвера
__get()source public
__get( string $property )
Магический геттер для возвращения $queryString в качестве только для чтения.
Параметры
- string
$property - внутреннее свойство для получения
Возвращает
mixedbind()source public
bind( array $params , array $types )
Связывает набор значений с объектом оператора с соответствующим типом
Параметры
- array
$params - список значений для привязки
- array
$types - список типов для использования, ключи должны совпадать с ключами в $params
Реализация
Cake\Database\StatementInterface::bind() bindValue()source public
bindValue( string|integer $column , mixed $value , string $type = 'string' )
Присваивает значение позиционной или именованной переменной в подготовленном запросе. Если вы используете позиционные переменные, вам нужно начать с индекса один, если вы используете именованные параметры, то просто используйте имя в любом порядке.
Параметры
- string|integer
$column - имя или позиция параметра для привязки
- mixed
$value - значение для привязки к переменной в запросе
- string
$typeoptional 'string' - имя настроенного класса типа
Реализация
Cake\Database\StatementInterface::bindValue() closeCursor()source public
closeCursor( )
Закрывает курсор в базе данных, освобождая все ресурсы и память, выделенные для него. В большинстве случаев вам не нужно вызывать этот метод, так как он автоматически вызывается после извлечения всех результатов из набора результатов.
Реализация
Cake\Database\StatementInterface::closeCursor() columnCount()source public
columnCount( )
Возвращает количество столбцов, которые будут содержать результаты данного запроса.
Возвращает
integerРеализация
Cake\Database\StatementInterface::columnCount() count()source public
count( )
Для подсчета количества строк, затронутых последним выполнением, запросы могут быть переданы в качестве аргумента count().
Возвращает
integerРеализация
Cake\Database\StatementInterface::count() current()source public
current( )
Возвращает текущую запись в итераторе.
Возвращает
mixedРеализация
Iterator::current() errorCode()source public
errorCode( )
Возвращает код ошибки для последней ошибки, произошедшей при выполнении данного запроса.
Возвращает
integer|stringРеализация
Cake\Database\StatementInterface::errorCode() errorInfo()source public
errorInfo( )
Возвращает информацию об ошибке для последней ошибки, произошедшей при выполнении данного запроса.
Возвращает
arrayРеализация
Cake\Database\StatementInterface::errorInfo() execute()source public
execute( array|null $params = null )
Выполняет запрос, отправляя SQL-запрос в базу данных. Он может необязательно принимать массив или аргументы для привязки к переменным запроса. Обратите внимание, что привязка параметров из этого метода не будет выполнять преобразование типов, как обычно происходит при вызове bindValue
Параметры
- array|null
$paramsнеобязательно null - список значений для привязки к переменным запроса
Возвращает
booleantrue при успехе, иначе false
Реализация
Cake\Database\StatementInterface::execute() fetch()source public
fetch( string $type = self::FETCH_TYPE_NUM )
Возвращает следующую строку набора результатов после выполнения этого запроса. Строки могут быть извлечены для содержания столбцов как имен, так и позиций. Если в наборе результатов больше нет строк, этот метод вернёт false
Параметры
- string
$typeнеобязательно self::FETCH_TYPE_NUM - Тип извлечения.
Возвращает
array|falseРеализация
Cake\Database\StatementInterface::fetch() fetchAll()source public
fetchAll( string $type = self::FETCH_TYPE_NUM )
Возвращает массив со всеми строками, полученными в результате выполнения этого запроса.
Параметры
- string
$typeнеобязательно self::FETCH_TYPE_NUM - Тип извлечения.
Возвращает
arrayРеализация
Cake\Database\StatementInterface::fetchAll() fetchAssoc()source public
fetchAssoc( )
fetchColumn()source public
fetchColumn( $position )
getInnerStatement()source public
getInnerStatement( )
Получить обернутый запрос.
Возвращает
Cake\Database\StatementInterfacekey()source public
key( )
Возвращает текущий ключ в итераторе.
Возвращает
mixedРеализация
Iterator::key() lastInsertId()source public
lastInsertId( string|null $table = null , string|null $column = null )
Возвращает последний вставленный первичный ключ, используя этот запрос.
Параметры
- string|null
$tableнеобязательно null - имя таблицы или последовательности, для получения последнего значения вставки
- string|null
$columnнеобязательно null - имя столбца, представляющего первичный ключ
Возвращает
stringРеализация
Cake\Database\StatementInterface::lastInsertId() next()source public
next( )
Перемещает указатель итератора к следующему элементу.
Реализация
Iterator::next() rowCount()source public
rowCount( )
Возвращает количество строк, затронутых этим SQL-запросом.
Возвращает
integerРеализация
Cake\Database\StatementInterface::rowCount() valid()source public
valid( )
Возвращает, есть ли у итератора дополнительные элементы.
Возвращает
booleanРеализация
Iterator::valid() Методы, используемые из Cake\Database\TypeConverterTrait
cast()source public
cast( mixed $value , Cake\Database\Type|string $type )
Преобразует данное значение в подходящее значение для базы данных на основе типа и возвращает соответствующий внутренний тип запроса.
Параметры
- mixed
$value - Значение для преобразования.
-
Cake\Database\Type|string$type - Имя типа или экземпляр типа для использования.
Возвращает
arrayсписок, содержащий преобразованное значение и внутренний тип
matchTypes()source public
matchTypes( array $columns , array $types )
Сопоставляет столбцы с соответствующими типами.
И $columns, и $types должны быть либо числовыми, либо строковыми ключами одновременно.
Параметры
- array
$columns - список или ассоциативный массив столбцов и параметров для привязки с типами
- array
$types - список или ассоциативный массив типов
Возвращает
arrayПодробности свойств
END_OF_DOCUMENT_MARKER$buffersource
protected массив
Кэш в оперативной памяти, содержащий результаты предыдущих итераторов
[]
© 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.8/class-Cake.Database.Statement.BufferedStatement.html