A statement decorator that implements buffered results.
This statement decorator will save fetched results in memory, allowing the iterator to be rewound and reused.
$_allFetched
protected boolean
$_driver
protected $_hasExecuted
protected boolean
$buffer
protected array
$index
protected integer
$statement
protected Assign a value to a positional or named variable in prepared query. If using positional variables you need to start with index one, if using named params then just use the name in any order.
Closes a cursor in the database, freeing up any resources and memory allocated to it. In most cases you don't need to call this method, as it is automatically called after fetching all results from the result set.
Statements can be passed as argument for count() to return the number for affected rows from last execution.
Returns the error information for the last error that occurred when executing this statement
Executes the statement by sending the SQL query to the database. It can optionally take an array or arguments to be bound to the query variables. Please note that binding parameters from this method will not perform any custom type conversion as it would normally happen when calling bindValue
Returns the next row for the result set after executing this statement. Rows can be fetched to contain columns as names or positions. If no rows are left in result set, this method will return false
__construct( Cake\Database\StatementInterface $statement , Cake\Database\Driver $driver )
Constructor
Cake\Database\StatementInterface
$statement
Cake\Database\Driver
$driver
__get( string $property )
Magic getter to return $queryString as read-only.
$property
bind( array $params , array $types )
Binds a set of values to statement object with corresponding type
$params
$types
Cake\Database\StatementInterface::bind()
bindValue( string|integer $column , mixed $value , string $type = 'string' )
Assign a value to a positional or named variable in prepared query. If using positional variables you need to start with index one, if using named params then just use the name in any order.
$column
$value
$type
optional 'string' Cake\Database\StatementInterface::bindValue()
closeCursor( )
Closes a cursor in the database, freeing up any resources and memory allocated to it. In most cases you don't need to call this method, as it is automatically called after fetching all results from the result set.
Cake\Database\StatementInterface::closeCursor()
columnCount( )
Returns the number of columns this statement's results will contain
Cake\Database\StatementInterface::columnCount()
count( )
Statements can be passed as argument for count() to return the number for affected rows from last execution.
Cake\Database\StatementInterface::count()
current( )
Returns the current record in the iterator
Iterator::current()
errorCode( )
Returns the error code for the last error that occurred when executing this statement
Cake\Database\StatementInterface::errorCode()
errorInfo( )
Returns the error information for the last error that occurred when executing this statement
Cake\Database\StatementInterface::errorInfo()
execute( array|null $params = null )
Executes the statement by sending the SQL query to the database. It can optionally take an array or arguments to be bound to the query variables. Please note that binding parameters from this method will not perform any custom type conversion as it would normally happen when calling bindValue
$params
optional null Cake\Database\StatementInterface::execute()
fetch( string $type = self::FETCH_TYPE_NUM )
Returns the next row for the result set after executing this statement. Rows can be fetched to contain columns as names or positions. If no rows are left in result set, this method will return false
$type
optional self::FETCH_TYPE_NUM Cake\Database\StatementInterface::fetch()
fetchAll( string $type = self::FETCH_TYPE_NUM )
Returns an array with all rows resulting from executing this statement
$type
optional self::FETCH_TYPE_NUM Cake\Database\StatementInterface::fetchAll()
fetchAssoc( )
fetchColumn( $position )
getInnerStatement( )
Get the wrapped statement
Cake\Database\StatementInterface
key( )
Returns the current key in the iterator
Iterator::key()
lastInsertId( string|null $table = null , string|null $column = null )
Returns the latest primary inserted using this statement
$table
optional null $column
optional null Cake\Database\StatementInterface::lastInsertId()
next( )
Advances the iterator pointer to the next element
Iterator::next()
rowCount( )
Returns the number of rows affected by this SQL statement
Cake\Database\StatementInterface::rowCount()
valid( )
Returns whether or not the iterator has more elements
Iterator::valid()
cast( mixed $value , Cake\Database\Type|string $type )
Converts a give value to a suitable database value based on type and return relevant internal statement type
$value
Cake\Database\Type
|string $type
matchTypes( array $columns , array $types )
Matches columns to corresponding types
Both $columns and $types should either be numeric based or string key based at the same time.
$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.8/class-Cake.Database.Statement.BufferedStatement.html