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.

Cake\Database\Statement\BufferedStatement implements Iterator, Cake\Database\StatementInterface uses Cake\Database\TypeConverterTrait

Namespace: Cake\Database\Statement
Location: Database/Statement/BufferedStatement.php

Inherited Constants

FETCH_TYPE_ASSOC, FETCH_TYPE_NUM, FETCH_TYPE_OBJ

Properties summary

$_allFetched protected

boolean

If true, all rows were fetched
$_driver protected

Cake\Database\DriverInterface

The driver for the statement
$_hasExecuted protected

boolean

Whether or not this statement has already been executed
$buffer protected

array

The in-memory cache containing results from previous iterators
$index protected

integer

The current iterator index.
$statement protected

Cake\Database\StatementInterface

The 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.
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
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
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\Driver $driver )

Constructor

Parameters

Cake\Database\StatementInterface $statement: Statement implementation such as PDOStatement
Cake\Database\Driver $driver: Driver instance

__get() public ¶

__get( string $property )

Magic getter to return $queryString as read-only.

Parameters

string $property: internal property to get

Returns

mixed

_reset() protected ¶

_reset( )

Reset all properties

bind() public ¶

bind( array $params , array $types )

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

Implementation of

Cake\Database\StatementInterface::bind()

bindValue() public ¶

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.

Parameters

string|integer $column: name or param position to be bound
mixed $value: The value to bind to variable in query
string $type optional 'string': name of configured Type class

Implementation of

Cake\Database\StatementInterface::bindValue()

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.

Implementation of

Cake\Database\StatementInterface::closeCursor()

columnCount() public ¶

columnCount( )

Returns the number of columns this statement's results will contain

Returns

integer

Implementation of

Cake\Database\StatementInterface::columnCount()

count() public ¶

count( )

Statements can be passed as argument for count() to return the number for affected rows from last execution.

Returns

integer

Implementation of

Cake\Database\StatementInterface::count()

current() public ¶

current( )

Returns the current record in the iterator

Returns

mixed

Implementation of

Iterator::current()

errorCode() public ¶

errorCode( )

Returns the error code for the last error that occurred when executing this statement

Returns

integer|string

Implementation of

Cake\Database\StatementInterface::errorCode()

errorInfo() public ¶

errorInfo( )

Returns the error information for the last error that occurred when executing this statement

Returns

array

Implementation of

Cake\Database\StatementInterface::errorInfo()

execute() public ¶

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

Parameters

array|null $params optional null: list of values to be bound to query

Returns

boolean
true on success, false otherwise

Implementation of

Cake\Database\StatementInterface::execute()

fetch() public ¶

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

Parameters

string $type optional self::FETCH_TYPE_NUM: The type to fetch.

Returns

array|false

Implementation of

Cake\Database\StatementInterface::fetch()

fetchAll() public ¶

fetchAll( string $type self::FETCH_TYPE_NUM )

Returns an array with all rows resulting from executing this statement

Parameters

string $type optional self::FETCH_TYPE_NUM: The type to fetch.

Returns

array

Implementation of

Cake\Database\StatementInterface::fetchAll()

fetchAssoc() public ¶

fetchAssoc( )

fetchColumn() public ¶

fetchColumn( $position )

getInnerStatement() public ¶

getInnerStatement( )

Get the wrapped statement

Returns

Cake\Database\StatementInterface

key() public ¶

key( )

Returns the current key in the iterator

Returns

mixed

Implementation of

Iterator::key()

lastInsertId() public ¶

lastInsertId( string|null $table null , string|null $column null )

Returns the latest primary inserted using this statement

Parameters

string|null $table optional null: table name or sequence to get last insert value from
string|null $column optional null: the name of the column representing the primary key

Returns

string

Implementation of

Cake\Database\StatementInterface::lastInsertId()

next() public ¶

next( )

Advances the iterator pointer to the next element

Implementation of

Iterator::next()

rewind() public ¶

rewind( )

Rewinds the collection

Implementation of

Iterator::rewind()

rowCount() public ¶

rowCount( )

Returns the number of rows affected by this SQL statement

Returns

integer

Implementation of

Cake\Database\StatementInterface::rowCount()

valid() public ¶

valid( )

Returns whether or not the iterator has more elements

Returns

boolean

Implementation of

Iterator::valid()

Methods used from Cake\Database\TypeConverterTrait

cast() public ¶

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

Parameters

mixed $value: The value to cast
Cake\Database\Type|string $type: The type name or type instance to use.

Returns

array
list containing converted value and internal type

matchTypes() public ¶

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.

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

Properties detail

`$_allFetched` ¶

protected boolean

If true, all rows were fetched

false

`$_driver` ¶

protected Cake\Database\DriverInterface

The driver for the statement

`$_hasExecuted` ¶

protected boolean

Whether or not this statement has already been executed

false

`$buffer` ¶

protected array

The in-memory cache containing results from previous iterators

[]

`$index` ¶

protected integer

The current iterator index.

`$statement` ¶

protected Cake\Database\StatementInterface

The decorated statement

Namespaces

Classes

Class BufferedStatement

Inherited Constants

Properties summary

Method Summary

__construct() public

__get() public

_reset() protected

bind() public

bindValue() public

closeCursor() public

columnCount() public

count() public

current() public

errorCode() public

errorInfo() public

execute() public

fetch() public

fetchAll() public

fetchAssoc() public

fetchColumn() public

getInnerStatement() public

key() public

lastInsertId() public

next() public

rewind() public

rowCount() public

valid() public

Method Detail

__construct() public ¶

Parameters

__get() public ¶

Parameters

Returns

_reset() protected ¶

bind() public ¶

Parameters

Implementation of

bindValue() public ¶

Parameters

Implementation of

closeCursor() public ¶

Implementation of

columnCount() public ¶

Returns

Implementation of

count() public ¶

Returns

Implementation of

current() public ¶

Returns

Implementation of

errorCode() public ¶

Returns

Implementation of

errorInfo() public ¶

Returns

Implementation of

execute() public ¶

Parameters

Returns

Implementation of

fetch() public ¶

Parameters

Returns

Implementation of

fetchAll() public ¶

Parameters

Returns

Implementation of

fetchAssoc() public ¶

fetchColumn() public ¶

getInnerStatement() public ¶

Returns

key() public ¶

Returns

Implementation of

lastInsertId() public ¶

Parameters

`$_allFetched` ¶

`$_driver` ¶

`$_hasExecuted` ¶

`$buffer` ¶

`$index` ¶

`$statement` ¶