$queryString
$queryString : string
Statement decorator used to
This class is but a decorator of an actual statement implementation, such as PDOStatement.
$_statement : \Cake\Database\StatementInterface|\PDOStatement|null
Statement instance implementation, such as PDOStatement or any other custom implementation.
$_driver : \Cake\Database\Driver|null
Reference to the driver object associated to this statement.
$_logger : \Cake\Database\Log\QueryLogger|null
Logger instance responsible for actually doing the logging task
__construct(\Cake\Database\StatementInterface|\PDOStatement|null $statement = null, \Cake\Database\Driver|null $driver = null)
Constructor
| \Cake\Database\StatementInterface|\PDOStatement|null | $statement | Statement implementation such as PDOStatement |
| \Cake\Database\Driver|null | $driver | Driver instance |
bindValue(string|integer $column, mixed $value, string|integer|null $type = 'string') : void
Wrapper for bindValue function to gather each parameter to be later used in the logger function.
It is not allowed to combine positional and named variables in the same statement.
$statement->bindValue(1, 'a title');
$statement->bindValue('active', true, 'boolean');
$statement->bindValue(5, new \DateTime(), 'date');| string|integer | $column | Name or param position to be bound |
| mixed | $value | The value to bind to variable in query |
| string|integer|null | $type | PDO type or name of configured Type class |
execute(array|null $params = null) : boolean
Wrapper for the execute function to calculate time spent and log the query afterwards.
| array|null | $params | List of values to be bound to query |
Re-throws any exception raised during query execution.
True on success, false otherwise
fetch(string $type = self::FETCH_TYPE_NUM) : array|false
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.
$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->fetch('assoc')); // will show ['id' => 1, 'title' => 'a title']| string | $type | 'num' for positional columns, assoc for named columns |
Result array containing columns and values or false if no results are left
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.
Result array containing columns and values an an associative array or an empty array if no results
fetchAll(string $type = self::FETCH_TYPE_NUM) : array
Returns an array with all rows resulting from executing this statement.
$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->fetchAll('assoc')); // will show [0 => ['id' => 1, 'title' => 'a title']]| string | $type | num for fetching columns as positional keys or assoc for column names as keys |
List of all results from database for this statement
getIterator() : \Cake\Database\StatementInterface|\PDOStatement
Statements are iterable as arrays, this method will return the iterator object for traversing all items in the result.
$statement = $connection->prepare('SELECT id, title from articles');
foreach ($statement as $row) {
//do stuff
}lastInsertId(string|null $table = null, string|null $column = null) : string|integer
Returns the latest primary inserted using this statement.
| 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 |
getInnerStatement() : \Cake\Database\StatementInterface|\PDOStatement
Returns the statement object that was decorated by this class.
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
| mixed | $value | The value to cast |
| \Cake\Database\Type|string | $type | The type name or type instance to use. |
list containing converted value and internal type
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.
| array | $columns | list or associative array of columns and parameters to be bound with types |
| array | $types | list or associative array of types |
logger(\Cake\Database\Log\QueryLogger|null $instance = null) : \Cake\Database\Log\QueryLogger|null
Sets the logger object instance. When called with no arguments it returns the currently setup logger instance
| \Cake\Database\Log\QueryLogger|null | $instance | Logger object instance. |
Logger instance
setLogger(\Cake\Database\Log\QueryLogger $logger) : void
Sets a logger
| \Cake\Database\Log\QueryLogger | $logger | Logger object |
getLogger() : \Cake\Database\Log\QueryLogger
Gets the logger object
logger instance
_log(\Cake\Database\Log\LoggedQuery $query, array $params, float $startTime) : void
Copies the logging data to the passed LoggedQuery and sends it to the logging system.
| \Cake\Database\Log\LoggedQuery | $query | The query to log. |
| array | $params | List of values to be bound to query. |
| float | $startTime | The microtime when the query was executed. |