W3cubDocs

/CakePHP 3.8

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

Inherited Constants

Properties summary

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
  • Get the wrapped statement
  • key() public
    Returns the current key in the iterator
  • 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()source 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()source public

__get( string $property )

Magic getter to return $queryString as read-only.

Parameters

string $property
internal property to get

Returns

mixed

_reset()source protected

_reset( )

Reset all properties

bind()source 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()source 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()

closeCursor()source public

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.

Implementation of

Cake\Database\StatementInterface::closeCursor()

columnCount()source public

columnCount( )

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

Returns

integer

Implementation of

Cake\Database\StatementInterface::columnCount()

count()source 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()source public

current( )

Returns the current record in the iterator

Returns

mixed

Implementation of

Iterator::current()

errorCode()source 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()source 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()source 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()source 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()source 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()source public

fetchAssoc( )

fetchColumn()source public

fetchColumn( $position )

getInnerStatement()source public

getInnerStatement( )

Get the wrapped statement

Returns

Cake\Database\StatementInterface

key()source public

key( )

Returns the current key in the iterator

Returns

mixed

Implementation of

Iterator::key()

lastInsertId()source 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()source public

next( )

Advances the iterator pointer to the next element

Implementation of

Iterator::next()

rewind()source public

rewind( )

Rewinds the collection

Implementation of

Iterator::rewind()

rowCount()source public

rowCount( )

Returns the number of rows affected by this SQL statement

Returns

integer

Implementation of

Cake\Database\StatementInterface::rowCount()

valid()source public

valid( )

Returns whether or not the iterator has more elements

Returns

boolean

Implementation of

Iterator::valid()

Methods used from Cake\Database\TypeConverterTrait

cast()source 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()source 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

$_allFetchedsource

protected boolean

If true, all rows were fetched

false

$_driversource

protected Cake\Database\DriverInterface

The driver for the statement

$_hasExecutedsource

protected boolean

Whether or not this statement has already been executed

false

$buffersource

protected array

The in-memory cache containing results from previous iterators

[]

$indexsource

protected integer

The current iterator index.

$statementsource

protected Cake\Database\StatementInterface

The decorated statement

© 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/3.8/class-Cake.Database.Statement.BufferedStatement.html