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.
Property Summary
-
$_allFetched protected
bool
If true, all rows were fetched
-
$_count protected
int
Records count
-
$_counter protected
int
Current record pointer
-
$_driver protected
Cake\Database\Driver
Reference to the driver object associated to this statement.
-
$_hasExecuted protected
bool
Whether or not this statement has already been executed
-
$_records protected
array
Array of results
-
$_statement protected
mixed
Statement instance implementation, such as PDOStatement or any other custom implementation.
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.
-
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
Execute the statement and return the results.
-
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.
-
getInnerStatement() public
Returns the statement object that was decorated by this class.
-
getIterator() public
Statements are iterable as arrays, this method will return the iterator object for traversing all items in the result.
-
lastInsertId() public
Returns the latest primary inserted using this statement.
-
matchTypes() public
Matches columns to corresponding types
-
rewind() public
Rewind the _counter property
-
rowCount() public
Returns the number of rows affected by this SQL statement.
Method Detail
__construct() ¶ public
__construct(Cake\Database\StatementInterface|null $statement = null, Cake\Database\Driver|null $driver = null)
Constructor
Parameters
-
Cake\Database\StatementInterface|null
$statement optional Statement implementation such as PDOStatement
-
Cake\Database\Driver|null
$driver optional Driver instance
__get() ¶ public
__get(string $property): mixed
Magic getter to return $queryString as read-only.
Parameters
-
string
$property internal property to get
Returns
mixed
bind() ¶ public
bind(array $params, array $types): void
Binds a set of values to statement object with corresponding type.
Parameters
-
array
$params list of values to be bound
-
array
$types list of types to be used, keys should match those in $params
Returns
void
bindValue() ¶ public
bindValue(string|int $column, mixed $value, string $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.
Examples:
$statement->bindValue(1, 'a title');
$statement->bindValue('active', true, 'boolean');
$statement->bindValue(5, new \DateTime(), 'date');
Parameters
-
string|int
$column name or param position to be bound
-
mixed
$value The value to bind to variable in query
-
string
$type optional name of configured Type class
Returns
void
cast() ¶ public
cast(mixed $value, Cake\Database\Type|string $type): array
Converts 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\Type|string
$type The type name or type instance to use.
Returns
array
closeCursor() ¶ public
closeCursor(): 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.
Returns
void
columnCount() ¶ public
columnCount(): int
Returns 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 2
Returns
int
count() ¶ public
count(): int
Statements can be passed as argument for count() to return the number for affected rows from last execution.
Returns
int
errorCode() ¶ public
errorCode(): int|string
Returns the error code for the last error that occurred when executing this statement.
Returns
int|string
errorInfo() ¶ public
errorInfo(): array
Returns the error information for the last error that occurred when executing this statement.
Returns
array
execute() ¶ public
execute(array $params = null): bool
Execute the statement and return the results.
Parameters
-
array
$params optional list of values to be bound to query
Returns
bool
fetch() ¶ public
fetch(string $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.
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
$type optional The type to fetch.
Returns
array|false
fetchAll() ¶ public
fetchAll(string $type = 'num'): array
Returns 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
$type optional The type to fetch.
Returns
array
getInnerStatement() ¶ public
getInnerStatement(): Cake\Database\StatementInterface
Returns the statement object that was decorated by this class.
Returns
Cake\Database\StatementInterface
getIterator() ¶ public
getIterator(): Iterator
Statements are iterable as arrays, this method will return the iterator object for traversing all items in the result.
Example:
$statement = $connection->prepare('SELECT id, title from articles');
foreach ($statement as $row) {
//do stuff
}
Returns
Iterator
lastInsertId() ¶ public
lastInsertId(string|null $table = null, string|null $column = null): string
Returns the latest primary inserted using this statement.
Parameters
-
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
Returns
string
matchTypes() ¶ public
matchTypes(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.
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
array
rowCount() ¶ public
rowCount(): int
Returns 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 1
Returns
int