Statement decorator used to
string
'assoc'
string
'num'
string
'obj'
array
Holds bound params
\Cake\Database\DriverInterface
Reference to the driver object associated to this statement.
bool
Whether or not this statement has already been executed
\Psr\Log\LoggerInterface
Logger instance responsible for actually doing the logging task
\Cake\Database\StatementInterface
Statement instance implementation, such as PDOStatement or any other custom implementation.
\Cake\Database\Log\LoggedQuery|null
Logged query
float
Query execution start time.
Copies the logging data to the passed LoggedQuery and sends it to the logging system.
Wrapper for bindValue function to gather each parameter to be later used in the logger function.
Converts a give value to a suitable database value based on type and return relevant internal statement type
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.
Statements can be passed as argument for count() to return the number for affected rows from last execution.
Returns the error code for the last error that occurred when executing this statement.
Returns the error information for the last error that occurred when executing this statement.
Wrapper for the execute function to calculate time spent and log the query afterwards.
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.
Statements are iterable as arrays, this method will return the iterator object for traversing all items in the result.
__construct(\Cake\Database\StatementInterface $statement, \Cake\Database\DriverInterface $driver)
Constructor
\Cake\Database\StatementInterface
$statement Statement implementation such as PDOStatement.
\Cake\Database\DriverInterface
$driver Driver instance
__get(string $property)
Magic getter to return $queryString as read-only.
string
$property internal property to get
mixed
_log()
Copies the logging data to the passed LoggedQuery and sends it to the logging system.
bind(array $params, array $types)
Binds a set of values to statement object with corresponding type.
array
$params list of values to be bound
array
$types list of types to be used, keys should match those in $params
bindValue(mixed $column, mixed $value, mixed $type)
Wrapper for bindValue function to gather each parameter to be later used in the logger function.
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 PDO type or name of configured Type class
cast(mixed $value, mixed $type)
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\TypeInterface|string|int
$type optional The type name or type instance to use.
array
list containing converted value and internal type
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()
Returns the number of columns this statement's results will contain.
$statement = $connection->prepare('SELECT id, title from articles'); $statement->execute(); echo $statement->columnCount(); // outputs 2
int
count()
Statements can be passed as argument for count() to return the number for affected rows from last execution.
int
errorCode()
Returns the error code for the last error that occurred when executing this statement.
int|string
errorInfo()
Returns the error information for the last error that occurred when executing this statement.
array
execute(?array $params)
Wrapper for the execute function to calculate time spent and log the query afterwards.
array|null
$params optional List of values to be bound to query
bool
True on success, false otherwise
Exception
fetch(mixed $type)
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|int
$type optional 'num' for positional columns, assoc for named columns
mixed
Result array containing columns and values or false if no results are left
fetchAll(mixed $type)
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|int
$type optional num for fetching columns as positional keys or assoc for column names as keys
array|false
List of all results from database for this statement. False on failure.
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.
array
Result array containing columns and values an an associative array or an empty array if no results
fetchColumn(int $position)
Returns the value of the result at position.
int
$position The numeric position of the column to retrieve in the result
mixed
Returns the specific value of the column designated at $position
getInnerStatement()
Returns the statement object that was decorated by this class.
\Cake\Database\StatementInterface
getIterator()
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 }
\Cake\Database\StatementInterface
getLogger()
Gets the logger object
\Psr\Log\LoggerInterface
logger instance
lastInsertId(?string $table, ?string $column)
Returns the latest primary inserted using this statement.
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
string|int
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.
array
$columns list or associative array of columns and parameters to be bound with types
array
$types list or associative array of types
array
rowCount()
Returns the number of rows affected by this SQL statement.
$statement = $connection->prepare('SELECT id, title from articles'); $statement->execute(); print_r($statement->rowCount()); // will show 1
int
setLogger(\Psr\Log\LoggerInterface $logger)
Sets a logger
\Psr\Log\LoggerInterface
$logger Logger object
Holds bound params
array
Reference to the driver object associated to this statement.
\Cake\Database\DriverInterface
Whether or not this statement has already been executed
bool
Logger instance responsible for actually doing the logging task
\Psr\Log\LoggerInterface
Statement instance implementation, such as PDOStatement or any other custom implementation.
\Cake\Database\StatementInterface
Logged query
\Cake\Database\Log\LoggedQuery|null
Query execution start time.
float
© 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.Log.LoggingStatement.html