W3cubDocs

/CakePHP 4.1

Class CallbackStatement

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.

Namespace: Cake\Database\Statement

Constants summary

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

Properties summary

  • $_callback protected
    callable

    A callback function to be applied to results.

  • $_driver protected
    \Cake\Database\DriverInterface

    Reference to the driver object associated to this statement.

  • $_hasExecuted protected
    bool

    Whether or not this statement has already been executed

  • $_statement protected
    \Cake\Database\StatementInterface

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

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.

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

  • 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

    Fetch a row from the statement.

  • fetchAll() public

    Fetch all rows from the 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.

  • matchTypes() public

    Matches columns to corresponding types

  • rowCount() public

    Returns the number of rows affected by this SQL statement.

Method Detail

__construct() public 

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

Constructor

Parameters

\Cake\Database\StatementInterface $statement

The statement to decorate.

\Cake\Database\DriverInterface $driver

The driver instance used by the statement.

callable $callback

The callback to apply to results before they are returned.

__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

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

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

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)

Fetch a row from the statement.

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

Parameters

string|int $type optional

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

Returns

array|false

fetchAll() public 

fetchAll(mixed $type)

Fetch all rows from the statement.

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

Parameters

string|int $type optional

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

Returns

array

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

Returns the statement object that was decorated by this class.

Returns

\Cake\Database\StatementInterface

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

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

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

Property Detail

$_callback protected

A callback function to be applied to results.

Type

callable

$_driver protected

Reference to the driver object associated to this statement.

Type

\Cake\Database\DriverInterface

$_hasExecuted protected

Whether or not this statement has already been executed

Type

bool

$_statement protected

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

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.CallbackStatement.html