A statement decorator that implements buffered results.
This statement decorator will save fetched results in memory, allowing the iterator to be rewound and reused.
string 'assoc' string 'num' string 'obj' boolIf true, all rows were fetched
\Cake\Database\DriverInterfaceThe driver for the statement
boolWhether or not this statement has already been executed
arrayThe in-memory cache containing results from previous iterators
intThe current iterator index.
\Cake\Database\StatementInterfaceThe decorated statement
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.
Converts a give value to a suitable database value based on type and return relevant internal statement type
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 code for the last error that occurred when executing this statement
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
__construct(\Cake\Database\StatementInterface $statement, \Cake\Database\DriverInterface $driver)
Constructor
\Cake\Database\StatementInterface $statement Statement implementation such as PDOStatement
\Cake\Database\DriverInterface $driver Driver instance
__get(string $property)
Magic getter to return $queryString as read-only.
string $property internal property to get
mixed_reset()
Reset all properties
bind(array $params, array $types)
Binds a set of values to statement object with corresponding type
array $params list of values to be bound
array $types list of types to be used, keys should match those in $params
bindValue(mixed $column, mixed $value, mixed $type)
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.
It is not allowed to combine positional and named variables in the same statement
$statement->bindValue(1, 'a title');
$statement->bindValue('active', true, 'boolean');
$statement->bindValue(5, new \DateTime(), 'date'); string|int $column name or param position to be bound
mixed $value The value to bind to variable in query
string|int|null $type optional name of configured Type class, or PDO type constant.
cast(mixed $value, mixed $type)
Converts a give value to a suitable database value based on type and return relevant internal statement type
mixed $value The value to cast
\Cake\Database\TypeInterface|string|int $type optional The type name or type instance to use.
arraylist containing converted value and internal type
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.
columnCount()
Returns the number of columns this statement's results will contain
$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
echo $statement->columnCount(); // outputs 2 intcount()
Statements can be passed as argument for count() to return the number for affected rows from last execution.
intcurrent()
Returns the current record in the iterator
mixederrorCode()
Returns the error code for the last error that occurred when executing this statement
int|stringerrorInfo()
Returns the error information for the last error that occurred when executing this statement
arrayexecute(?array $params)
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
array|null $params optional list of values to be bound to query
booltrue on success, false otherwise
fetch(mixed $type)
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
$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->fetch('assoc')); // will show ['id' => 1, 'title' => 'a title'] int|string $type optional The type to fetch.
array|falsefetchAll(mixed $type)
Returns an array with all rows resulting from executing this statement
$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 optional num for fetching columns as positional keys or assoc for column names as keys
array|falselist of all results from database for this statement or false on failure.
fetchAssoc()
fetchColumn(int $position)
Returns the value of the result at position.
int $position The numeric position of the column to retrieve in the result
mixedReturns the specific value of the column designated at $position
getInnerStatement()
Get the wrapped statement
\Cake\Database\StatementInterfacekey()
Returns the current key in the iterator
mixedlastInsertId(?string $table, ?string $column)
Returns the latest primary inserted using this statement
string|null $table optional table name or sequence to get last insert value from
string|null $column optional the name of the column representing the primary key
string|intmatchTypes(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.
array $columns list or associative array of columns and parameters to be bound with types
array $types list or associative array of types
arraynext()
Advances the iterator pointer to the next element
rewind()
Rewinds the collection
rowCount()
Returns the number of rows affected by this SQL statement
$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->rowCount()); // will show 1 intvalid()
Returns whether or not the iterator has more elements
boolIf true, all rows were fetched
boolThe driver for the statement
\Cake\Database\DriverInterfaceWhether or not this statement has already been executed
boolThe in-memory cache containing results from previous iterators
arrayThe current iterator index.
intThe decorated statement
\Cake\Database\StatementInterface
© 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.1/class-Cake.Database.Statement.BufferedStatement.html