Class StatementDecorator

Represents a database statement. Statements contains queries that can be executed multiple times by binding different values on each call. This class also helps convert values to their valid representation for the corresponding types.

This class is but a decorator of an actual statement implementation, such as PDOStatement.

Cake\Database\Statement\StatementDecorator implements Cake\Database\StatementInterface, Countable, IteratorAggregate uses Cake\Database\TypeConverterTrait

Direct Subclasses

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

Inherited Constants

FETCH_TYPE_ASSOC, FETCH_TYPE_NUM, FETCH_TYPE_OBJ

Properties summary

$_driver protected

Cake\Database\Driver|null

Reference to the driver object associated to this statement.
$_hasExecuted protected

boolean

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

Cake\Database\StatementInterface|PDOStatement|null

Statement instance implementation, such as PDOStatement or any other custom implementation.

Magic properties summary

$queryString public

string

Method Summary

__construct() public

Constructor
__get() public

Magic getter to return $queryString as read-only.
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.
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

Returns the next row in a result set as an associative array. Calling this function is the same as calling $statement->fetch(StatementDecorator::FETCH_TYPE_ASSOC). If no results are found false is returned.
fetchColumn() public

Returns the value of the result at position.
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.
rowCount() public

Returns the number of rows affected by this SQL statement.

Method Detail

__construct() public ¶

__construct( Cake\Database\StatementInterface|PDOStatement|null $statement = null , Cake\Database\Driver|null $driver = null )

Constructor

Parameters

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

__get() public ¶

__get( string $property )

Magic getter to return $queryString as read-only.

Parameters

string $property: internal property to get

Returns

mixed

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.

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

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

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.

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 self::FETCH_TYPE_NUM: 'num' for positional columns, assoc for named columns

Returns

array|false

Result array containing columns and values or false if no results are left

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.

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 self::FETCH_TYPE_NUM: num for fetching columns as positional keys or assoc for column names as keys

Returns

array
List of all results from database for this statement

Implementation of

Cake\Database\StatementInterface::fetchAll()

fetchAssoc() public ¶

fetchAssoc( )

Returns the next row in a result set as an associative array. Calling this function is the same as calling $statement->fetch(StatementDecorator::FETCH_TYPE_ASSOC). If no results are found false is returned.

Returns

array
Result array containing columns and values an an associative array or an empty array if no results

fetchColumn() public ¶

fetchColumn( integer $position )

Returns the value of the result at position.

Parameters

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

Returns the statement object that was decorated by this class.

Returns

Cake\Database\StatementInterface|PDOStatement

getIterator() public ¶

getIterator( )

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

Cake\Database\StatementInterface|PDOStatement

Implementation of

IteratorAggregate::getIterator()

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

Implementation of

Cake\Database\StatementInterface::lastInsertId()

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

integer

Implementation of

Cake\Database\StatementInterface::rowCount()

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

`$_driver` ¶

protected Cake\Database\Driver|null

Reference to the driver object associated to this statement.

`$_hasExecuted` ¶

protected boolean

Whether or not this statement has already been executed

false

`$_statement` ¶

protected Cake\Database\StatementInterface|PDOStatement|null

Statement instance implementation, such as PDOStatement or any other custom implementation.

Magic properties detail

`$queryString` ¶

public read-only string

Namespaces

Classes

Class StatementDecorator

Direct Subclasses

Inherited Constants

Properties summary

Magic properties summary

Method Summary

__construct() public

__get() public

bind() public

bindValue() public

closeCursor() public

columnCount() public

count() public

errorCode() public

errorInfo() public

execute() public

fetch() public

fetchAll() public

fetchAssoc() public

fetchColumn() public

getInnerStatement() public

getIterator() public

lastInsertId() public

rowCount() public

Method Detail

__construct() public ¶

Parameters

__get() public ¶

Parameters

Returns

bind() public ¶

Parameters

Implementation of

bindValue() public ¶

Examples:

Parameters

Implementation of

closeCursor() public ¶

Implementation of

columnCount() public ¶

Example:

Returns

Implementation of

count() public ¶

Returns

Implementation of

errorCode() public ¶

Returns

Implementation of

errorInfo() public ¶

Returns

Implementation of

execute() public ¶

Parameters

Returns

Implementation of

fetch() public ¶

Example:

Parameters

Returns

Implementation of

fetchAll() public ¶

Example:

Parameters

Returns

Implementation of

fetchAssoc() public ¶

Returns

fetchColumn() public ¶

Parameters

Returns

getInnerStatement() public ¶

Returns

getIterator() public ¶

Example:

Returns

Implementation of

lastInsertId() public ¶

`$_driver` ¶

`$_hasExecuted` ¶

`$_statement` ¶

`$queryString` ¶