CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.3 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.3
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Console
    • Controller
    • Core
    • Database
      • Dialect
      • Driver
      • Exception
      • Expression
      • Log
      • Schema
      • Statement
      • Type
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

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

Property Summary

  • $_callback protected
    callable

    A callback function to be applied to results.

  • $_driver protected
    Cake\Database\Driver

    Reference to the driver object associated to this statement.

  • $_hasExecuted protected
    bool

    Whether or not this statement has already been executed

  • $_statement protected
    mixed

    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.

  • 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\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() ¶ public

__get(string $property): mixed

Magic getter to return $queryString as read-only.

Parameters
string $property

internal property to get

Returns
mixed

bind() ¶ public

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

Returns
void

bindValue() ¶ public

bindValue(string|int $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|int $column

name or param position to be bound

mixed $value

The value to bind to variable in query

string $type optional

name of configured Type class

Returns
void

cast() ¶ public

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

closeCursor() ¶ public

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.

Returns
void

columnCount() ¶ public

columnCount(): int

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

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

Returns
int

errorCode() ¶ public

errorCode(): int|string

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

Returns
int|string

errorInfo() ¶ public

errorInfo(): array

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

Returns
array

execute() ¶ public

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

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

fetch() ¶ public

fetch(string $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 optional

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

Returns
array|false

fetchAll() ¶ public

fetchAll(string $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 optional

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

Returns
array

getInnerStatement() ¶ public

getInnerStatement(): Cake\Database\StatementInterface

Returns the statement object that was decorated by this class.

Returns
Cake\Database\StatementInterface

getIterator() ¶ public

getIterator(): Iterator

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
Iterator

lastInsertId() ¶ public

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

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

matchTypes() ¶ public

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

rowCount() ¶ public

rowCount(): int

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\Driver

$_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
mixed
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs