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'
Used to designate that an associated array be returned in a result when calling fetch methods
string 'num'
Used to designate that numeric indexes be returned in a result when calling fetch methods
string 'obj'
Used to designate that a stdClass object be returned in a result when calling fetch methods
boolIf true, all rows were fetched
Cake\Database\DriverInterfaceThe driver for the statement
boolWhether this statement has already been executed
array<int, array>The in-memory cache containing results from previous iterators
intThe current iterator index.
stringCake\Database\StatementInterfaceThe decorated statement
Constructor
Magic getter to return $queryString as read-only.
Reset all properties
Binds a set of values to statement object with corresponding 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.
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.
Returns the number of columns this statement's results will contain
Statements can be passed as argument for count() to return the number for affected rows from last execution.
Returns the current record in the iterator
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
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
Returns an array with all rows resulting from executing this statement
Returns the value of the result at position.
Get the wrapped statement
Returns the current key in the iterator
Returns the latest primary inserted using this statement
Matches columns to corresponding types
Advances the iterator pointer to the next element
Rewinds the collection
Returns the number of rows affected by this SQL statement
Returns whether the iterator has more elements
__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): string|null
Magic getter to return $queryString as read-only.
string $property internal property to get
string|null_reset(): void
Reset all properties
voidbind(array $params, array $types): void
Binds a set of values to statement object with corresponding type
array $params array $types voidbindValue(string|int $column, mixed $value, string|int|null $type = 'string'): void
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 mixed $value string|int|null $type optional voidcast(mixed $value, Cake\Database\TypeInterface|string|int $type = 'string'): array
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.
arraycloseCursor(): void
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.
voidcolumnCount(): int
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(): int
Statements can be passed as argument for count() to return the number for affected rows from last execution.
intcurrent(): mixed
Returns the current record in the iterator
mixederrorCode(): string|int
Returns the error code for the last error that occurred when executing this statement
string|interrorInfo(): array
Returns the error information for the last error that occurred when executing this statement
arrayexecute(array|null $params = null): bool
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 boolfetch(string|int $type = self::FETCH_TYPE_NUM): array|false
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'] string|int $type optional The type to fetch.
array|falsefetchAll(string|int $type = self::FETCH_TYPE_NUM): array|false
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 array|falsefetchAssoc(): array
arrayfetchColumn(int $position): mixed
Returns the value of the result at position.
int $position mixedgetInnerStatement(): Cake\Database\StatementInterface
Get the wrapped statement
Cake\Database\StatementInterfacekey(): mixed
Returns the current key in the iterator
mixedlastInsertId(string|null $table = null, string|null $column = null): string|int
Returns the latest primary inserted using this statement
string|null $table optional string|null $column optional string|intmatchTypes(array $columns, array $types): array
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(): void
Advances the iterator pointer to the next element
voidrewind(): void
Rewinds the collection
voidrowCount(): int
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(): bool
Returns whether the iterator has more elements
boolIf true, all rows were fetched
boolThe driver for the statement
Cake\Database\DriverInterfaceWhether this statement has already been executed
boolThe in-memory cache containing results from previous iterators
array<int, array>The current iterator index.
intstringThe 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.4/class-Cake.Database.Statement.BufferedStatement.html