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.
- Cake\Database\Statement\StatementDecorator implements Cake\Database\StatementInterface, Countable, IteratorAggregate uses Cake\Database\TypeConverterTrait
-
Cake\Database\Statement\CallbackStatement
Inherited Constants
Properties summary
-
$_callbackprotectedcallableA callback function to be applied to results.
Inherited Magic Properties
Inherited Properties
Method Summary
-
__construct() public
Constructor -
fetch() public
Fetch a row from the statement. -
fetchAll() public
Fetch all rows from the 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.
Overrides
fetch() public ¶
fetch( string $type parent::FETCH_TYPE_NUM )
Fetch a row from the statement.
The result will be processed by the callback when it is not false.
Parameters
- string $type optional parent::FETCH_TYPE_NUM
- Either 'num' or 'assoc' to indicate the result format you would like.
Returns
Overrides
fetchAll() public ¶
fetchAll( string $type parent::FETCH_TYPE_NUM )
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 parent::FETCH_TYPE_NUM
- Either 'num' or 'assoc' to indicate the result format you would like.
Returns
Overrides
Methods inherited from Cake\Database\Statement\StatementDecorator
__get() public ¶
__get( string $property )
Magic getter to return $queryString as read-only.
Parameters
- string $property
- internal property to get
Returns
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
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
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
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
Implementation of
count() public ¶
count( )
Statements can be passed as argument for count() to return the number for affected rows from last execution.
Returns
Implementation of
errorCode() public ¶
errorCode( )
Returns the error code for the last error that occurred when executing this statement.
Returns
Implementation of
errorInfo() public ¶
errorInfo( )
Returns the error information for the last error that occurred when executing this statement.
Returns
Implementation of
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
true on success, false otherwise
Implementation of
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
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
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|PDOStatementgetIterator() 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|PDOStatementImplementation 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
Implementation of
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
Implementation of
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
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