Class LoggingStatement
Statement decorator used to
Constants summary
-
string
FETCH_TYPE_ASSOC'assoc'
-
string
FETCH_TYPE_NUM'num'
-
string
FETCH_TYPE_OBJ'obj'
Properties summary
- $_compiledParams protected
array
Holds bound params
- $_driver protected
\Cake\Database\DriverInterface
Reference to the driver object associated to this statement.
- $_hasExecuted protected
bool
Whether or not this statement has already been executed
- $_logger protected
\Psr\Log\LoggerInterface
Logger instance responsible for actually doing the logging task
- $_statement protected
\Cake\Database\StatementInterface
Statement instance implementation, such as PDOStatement or any other custom implementation.
Method Summary
- _log() protected
Copies the logging data to the passed LoggedQuery and sends it to the logging system.
- bindValue() public
Wrapper for bindValue function to gather each parameter to be later used in the logger function.
- 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.
- 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
Wrapper for the execute function to calculate time spent and log the query afterwards.
- fetchAssoc() public
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.
- getIterator() public
Statements are iterable as arrays, this method will return the iterator object for traversing all items in the result.
Method Detail
__construct() public
__construct(\Cake\Database\StatementInterface $statement, \Cake\Database\DriverInterface $driver)
Constructor
Parameters
-
\Cake\Database\StatementInterface
$statement Statement implementation such as PDOStatement.
-
\Cake\Database\DriverInterface
$driver Driver instance
__get() public
__get(string $property)
Magic getter to return $queryString as read-only.
Parameters
-
string
$property internal property to get
Returns
mixed
_log() protected
_log(\Cake\Database\Log\LoggedQuery $query, ?array $params, float $startTime)
Copies the logging data to the passed LoggedQuery and sends it to the logging system.
Parameters
-
\Cake\Database\Log\LoggedQuery
$query The query to log.
-
array|null
$params List of values to be bound to query.
-
float
$startTime The microtime when the query was executed.
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
bindValue() public
bindValue(mixed $column, mixed $value, mixed $type)
Wrapper for bindValue function to gather each parameter to be later used in the logger function.
Parameters
-
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() public
cast(mixed $value, mixed $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\TypeInterface|string|int
$type optional The type name or type instance to use.
Returns
array
list containing converted value and internal type
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.
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
int
count() public
count()
Statements can be passed as argument for count() to return the number for affected rows from last execution.
Returns
int
errorCode() public
errorCode()
Returns the error code for the last error that occurred when executing this statement.
Returns
int|string
errorInfo() public
errorInfo()
Returns the error information for the last error that occurred when executing this statement.
Returns
array
execute() public
execute(?array $params)
Wrapper for the execute function to calculate time spent and log the query afterwards.
Parameters
-
array|null
$params optional List of values to be bound to query
Returns
bool
True on success, false otherwise
Throws
Exception
Re-throws any exception raised during query execution.
fetch() public
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.
Example:
$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->fetch('assoc')); // will show ['id' => 1, 'title' => 'a title']
Parameters
-
string|int
$type optional 'num' for positional columns, assoc for named columns
Returns
mixed
Result array containing columns and values or false if no results are left
fetchAll() public
fetchAll(mixed $type)
Returns an array with all rows resulting from executing this statement.
Example:
$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->fetchAll('assoc')); // will show [0 => ['id' => 1, 'title' => 'a title']]
Parameters
-
string|int
$type optional num for fetching columns as positional keys or assoc for column names as keys
Returns
array|false
List of all results from database for this statement. False on failure.
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
array
Result array containing columns and values an an associative array or an empty array if no results
fetchColumn() public
fetchColumn(int $position)
Returns the value of the result at position.
Parameters
-
int
$position The numeric position of the column to retrieve in the result
Returns
mixed
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
getIterator() 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
getLogger() public
getLogger()
Gets the logger object
Returns
\Psr\Log\LoggerInterface
logger instance
lastInsertId() public
lastInsertId(?string $table, ?string $column)
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|int
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
Returns
array
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
int
setLogger() public
setLogger(\Psr\Log\LoggerInterface $logger)
Sets a logger
Parameters
-
\Psr\Log\LoggerInterface
$logger Logger object
Property Detail
$_compiledParams protected
Holds bound params
Type
array
$_driver protected
Reference to the driver object associated to this statement.
Type
\Cake\Database\DriverInterface
$_hasExecuted protected
Whether or not this statement has already been executed
Type
bool
$_logger protected
Logger instance responsible for actually doing the logging task
Type
\Psr\Log\LoggerInterface
$_statement protected
Statement instance implementation, such as PDOStatement or any other custom implementation.
Type
\Cake\Database\StatementInterface
© 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.0/class-Cake.Database.Log.LoggingStatement.html