$queryString
$queryString : string
Decorator for \PDOStatement class mainly used for converting human readable fetch modes into PDO constants.
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.
__construct(\PDOStatement|null $statement = null, \Cake\Database\Driver|null $driver = null)
Constructor
| \PDOStatement|null | $statement | Original statement to be decorated. |
| \Cake\Database\Driver|null | $driver | Driver instance. |
bindValue(string|integer $column, mixed $value, string|integer $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.
You can pass PDO compatible constants for binding values with a type or optionally any type name registered in the Type class. Any value will be converted to the valid type representation if needed.
It is not allowed to combine positional and named variables in the same statement
$statement->bindValue(1, 'a title');
$statement->bindValue(2, 5, PDO::INT);
$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 | $type | PDO type or name of configured Type class |
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`.
| array|null | $params | list of values to be bound to query |
true on success, false otherwise
fetch(string $type = parent::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 = parent::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 |