Class BufferedStatement
A statement decorator that implements buffered results.
This statement decorator will save fetched results in memory, allowing the iterator to be rewound and reused.
Constants
-
stringFETCH_TYPE_ASSOC ¶'assoc'Used to designate that an associated array be returned in a result when calling fetch methods
-
stringFETCH_TYPE_NUM ¶'num'Used to designate that numeric indexes be returned in a result when calling fetch methods
-
stringFETCH_TYPE_OBJ ¶'obj'Used to designate that a stdClass object be returned in a result when calling fetch methods
Property Summary
-
$_allFetched protected
boolIf true, all rows were fetched
-
$_driver protected
Cake\Database\DriverInterfaceThe driver for the statement
-
$_hasExecuted protected
boolWhether or not this statement has already been executed
-
$buffer protected
arrayThe in-memory cache containing results from previous iterators
-
$index protected
intThe current iterator index.
-
$queryString public @property-read
string -
$statement protected
Cake\Database\StatementInterfaceThe decorated statement
Method Summary
-
__construct() public
Constructor
-
__get() public
Magic getter to return $queryString as read-only.
-
_reset() protected
Reset all properties
-
bind() public
Binds a set of values to statement object with corresponding type
-
bindValue() public
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.
-
cast() public
Converts a give value to a suitable database value based on type and return relevant internal statement type
-
closeCursor() public
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() public
Returns the number of columns this statement's results will contain
-
count() public
Statements can be passed as argument for count() to return the number for affected rows from last execution.
-
current() public
Returns the current record in the iterator
-
errorCode() public
Returns the error code for the last error that occurred when executing this statement
-
errorInfo() public
Returns the error information for the last error that occurred when executing this statement
-
execute() public
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 -
fetch() public
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
-
fetchAll() public
Returns an array with all rows resulting from executing this statement
-
fetchAssoc() public
-
fetchColumn() public
Returns the value of the result at position.
-
getInnerStatement() public
Get the wrapped statement
-
key() public
Returns the current key in the iterator
-
lastInsertId() public
Returns the latest primary inserted using this statement
-
matchTypes() public
Matches columns to corresponding types
-
next() public
Advances the iterator pointer to the next element
-
rewind() public
Rewinds the collection
-
rowCount() public
Returns the number of rows affected by this SQL statement
-
valid() public
Returns whether or not the iterator has more elements
Method Detail
__construct() ¶ public
__construct(Cake\Database\StatementInterface $statement, Cake\Database\DriverInterface $driver)Constructor
Parameters
-
Cake\Database\StatementInterface$statement Statement implementation such as PDOStatement
-
Cake\Database\DriverInterface$driver Driver instance
__get() ¶ public
__get(string $property): mixedMagic getter to return $queryString as read-only.
Parameters
-
string$property internal property to get
Returns
mixedbind() ¶ public
bind(array $params, array $types): voidBinds a set of values to statement object with corresponding type
Parameters
-
array$params -
array$types
Returns
voidbindValue() ¶ public
bindValue(string|int $column, mixed $value, string|int|null $type = 'string'): voidAssign 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
Examples:
$statement->bindValue(1, 'a title');
$statement->bindValue('active', true, 'boolean');
$statement->bindValue(5, new \DateTime(), 'date');Parameters
-
string|int$column -
mixed$value -
string|int|null$type optional
Returns
voidcast() ¶ public
cast(mixed $value, Cake\Database\TypeInterface|string|int $type = 'string'): arrayConverts a give value to a suitable database value based on type and return relevant internal statement type
Parameters
-
mixed$value The value to cast
-
Cake\Database\TypeInterface|string|int$type optional The type name or type instance to use.
Returns
arraycloseCursor() ¶ public
closeCursor(): voidCloses 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
voidcolumnCount() ¶ public
columnCount(): intReturns the number of columns this statement's results will contain
Example:
$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
echo $statement->columnCount(); // outputs 2Returns
intcount() ¶ public
count(): intStatements can be passed as argument for count() to return the number for affected rows from last execution.
Returns
interrorCode() ¶ public
errorCode(): int|stringReturns the error code for the last error that occurred when executing this statement
Returns
int|stringerrorInfo() ¶ public
errorInfo(): arrayReturns the error information for the last error that occurred when executing this statement
Returns
arrayexecute() ¶ public
execute(array|null $params = null): boolExecutes 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
Parameters
-
array|null$params optional
Returns
boolfetch() ¶ public
fetch(string|int $type = self::FETCH_TYPE_NUM): array|falseReturns 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
Example:
$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->fetch('assoc')); // will show ['id' => 1, 'title' => 'a title']Parameters
-
string|int$type optional The type to fetch.
Returns
array|falsefetchAll() ¶ public
fetchAll(string|int $type = self::FETCH_TYPE_NUM): array|falseReturns an array with all rows resulting from executing this statement
Example:
$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->fetchAll('assoc')); // will show [0 => ['id' => 1, 'title' => 'a title']]Parameters
-
string|int$type optional
Returns
array|falsefetchColumn() ¶ public
fetchColumn(int $position): mixedReturns the value of the result at position.
Parameters
-
int$position
Returns
mixedgetInnerStatement() ¶ public
getInnerStatement(): Cake\Database\StatementInterfaceGet the wrapped statement
Returns
Cake\Database\StatementInterfacelastInsertId() ¶ public
lastInsertId(string|null $table = null, string|null $column = null): string|intReturns the latest primary inserted using this statement
Parameters
-
string|null$table optional -
string|null$column optional
Returns
string|intmatchTypes() ¶ public
matchTypes(array $columns, array $types): arrayMatches columns to corresponding types
Both $columns and $types should either be numeric based or string key based at the same time.
Parameters
-
array$columns list or associative array of columns and parameters to be bound with types
-
array$types list or associative array of types
Returns
arrayrowCount() ¶ public
rowCount(): intReturns the number of rows affected by this SQL statement
Example:
$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->rowCount()); // will show 1Returns
int