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.

Namespace: Cake\Database\Statement

Constants summary

  • string
    FETCH_TYPE_ASSOC
    'assoc'
  • string
    FETCH_TYPE_NUM
    'num'
  • string
    FETCH_TYPE_OBJ
    'obj'

Properties summary

  • $_allFetched protected
    bool

    If true, all rows were fetched

  • $_driver protected
    \Cake\Database\DriverInterface

    The driver for the statement

  • $_hasExecuted protected
    bool

    Whether or not this statement has already been executed

  • $buffer protected
    array

    The in-memory cache containing results from previous iterators

  • $index protected
    int

    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.

  • 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.

  • 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)

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

bindValue() public 

bindValue(mixed $column, mixed $value, mixed $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.

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|int|null $type optional

name of configured Type class, or PDO type constant.

cast() public 

cast(mixed $value, mixed $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\TypeInterface|string|int $type optional

The type name or type instance to use.

Returns

array

list containing converted value and internal type

closeCursor() 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.

columnCount() public 

columnCount()

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

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

Returns

int

current() public 

current()

Returns the current record in the iterator

Returns

mixed

errorCode() public 

errorCode()

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

Returns

int|string

errorInfo() public 

errorInfo()

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

Returns

array

execute() public 

execute(?array $params)

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

list of values to be bound to query

Returns

bool

true on success, false otherwise

fetch() public 

fetch(mixed $type)

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

int|string $type optional

The type to fetch.

Returns

array|false

fetchAll() public 

fetchAll(mixed $type)

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|int $type optional

num for fetching columns as positional keys or assoc for column names as keys

Returns

array|false

list of all results from database for this statement or false on failure.

fetchAssoc() public 

fetchAssoc()

fetchColumn() public 

fetchColumn(int $position)

Returns the value of the result at position.

Parameters

int $position

The numeric position of the column to retrieve in the result

Returns

mixed

Returns the specific value of the column designated at $position

getInnerStatement() public 

getInnerStatement()

Get the wrapped statement

Returns

\Cake\Database\StatementInterface

key() public 

key()

Returns the current key in the iterator

Returns

mixed

lastInsertId() public 

lastInsertId(?string $table, ?string $column)

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|int

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

next() public 

next()

Advances the iterator pointer to the next element

rewind() public 

rewind()

Rewinds the collection

rowCount() public 

rowCount()

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

valid() public 

valid()

Returns whether or not the iterator has more elements

Returns

bool

Property Detail

$_allFetched protected

If true, all rows were fetched

Type

bool

$_driver protected

The driver for the statement

Type

\Cake\Database\DriverInterface

$_hasExecuted protected

Whether or not this statement has already been executed

Type

bool

$buffer protected

The in-memory cache containing results from previous iterators

Type

array

$index protected

The current iterator index.

Type

int

$statement protected

The decorated statement

Type

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