\Cake\Database\StatementCallbackStatement

Wraps a statement in a callback that allows row results to be modified when being fetched.

This is used by CakePHP to eagerly load association data.

Summary

Methods

Properties

Constants

__construct()
__get()
bindValue()
closeCursor()
columnCount()
errorCode()
errorInfo()
execute()
fetch()
fetchAssoc()
fetchColumn()
fetchAll()
rowCount()
getIterator()
count()
bind()
lastInsertId()
getInnerStatement()
cast()
matchTypes()

$queryString

No constants found

No protected methods found

$_statement
$_driver
$_hasExecuted
$_callback

N/A

No private methods found

No private properties found

N/A

Properties

$queryString

$queryString : string

Type

string

$_statement

$_statement : \Cake\Database\StatementInterface|\PDOStatement|null

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

Type

\Cake\Database\StatementInterface|\PDOStatement|null

$_driver

$_driver : \Cake\Database\Driver|null

Reference to the driver object associated to this statement.

Type

\Cake\Database\Driver|null

$_hasExecuted

$_hasExecuted : boolean

Whether or not this statement has already been executed

Type

boolean

$_callback

$_callback : callable

A callback function to be applied to results.

Type

callable

Methods

__construct()

__construct(\Cake\Database\StatementInterface  $statement, \Cake\Database\Driver  $driver, callable  $callback)

Constructor

Parameters

\Cake\Database\StatementInterface	$statement	The statement to decorate.
\Cake\Database\Driver	$driver	The driver instance used by the statement.
callable	$callback	The callback to apply to results before they are returned.

__get()

__get(string  $property) : mixed

Magic getter to return $queryString as read-only.

Parameters

string

$property

internal property to get

Returns

mixed

bindValue()

bindValue(string|integer  $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\|integer	$column	name or param position to be bound
mixed	$value	The value to bind to variable in query
string	$type	name of configured Type class

closeCursor()

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.

columnCount()

columnCount() : integer

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

errorCode()

errorCode() : integer|string

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

Returns

integer|string

errorInfo()

errorInfo() : array

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

Returns

array

execute()

execute(array|null  $params = null) : boolean

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

list of values to be bound to query

Returns

boolean —

true on success, false otherwise

fetch()

fetch(string  $type = parent::FETCH_TYPE_NUM) : array|false

Fetch a row from the statement.

The result will be processed by the callback when it is not false.

Parameters

string

$type

Either 'num' or 'assoc' to indicate the result format you would like.

Returns

array|false

fetchAssoc()

fetchAssoc() : array

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

fetchColumn(integer  $position) : mixed|false

Returns the value of the result at position.

Parameters

integer

$position

The numeric position of the column to retrieve in the result

Returns

mixed|false —

Returns the specific value of the column designated at $position

fetchAll()

fetchAll(string  $type = parent::FETCH_TYPE_NUM) : array

Fetch all rows from the statement.

Each row in the result will be processed by the callback when it is not `false.

Parameters

string

$type

Either 'num' or 'assoc' to indicate the result format you would like.

Returns

array

rowCount()

rowCount() : integer

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

getIterator()

getIterator() : \Cake\Database\StatementInterface|\PDOStatement

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

count()

count() : integer

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

Returns

integer

bind()

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

lastInsertId()

lastInsertId(string|null  $table = null, string|null  $column = null) : string|integer

Returns the latest primary inserted using this statement.

Parameters

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

Returns

string|integer

getInnerStatement()

getInnerStatement() : \Cake\Database\StatementInterface|\PDOStatement

Returns the statement object that was decorated by this class.

Returns

\Cake\Database\StatementInterface|\PDOStatement

cast()

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 —

list containing converted value and internal type

matchTypes()

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