Class LoggingStatement
Statement decorator used to
Constants
-
stringFETCH_TYPE_ASSOC ¶'assoc'Used to designate that an associated array be returned in a result when calling fetch methods
-
stringFETCH_TYPE_NUM ¶'num'Used to designate that numeric indexes be returned in a result when calling fetch methods
-
stringFETCH_TYPE_OBJ ¶'obj'Used to designate that a stdClass object be returned in a result when calling fetch methods
Property Summary
-
$_compiledParams protected
arrayHolds bound params
-
$_driver protected
Cake\Database\Driver|nullReference to the driver object associated to this statement.
-
$_hasExecuted protected
boolWhether or not this statement has already been executed
-
$_logger protected
Cake\Database\Log\QueryLogger|nullLogger instance responsible for actually doing the logging task
-
$_statement protected
Cake\Database\StatementInterface|PDOStatement|nullStatement instance implementation, such as PDOStatement or any other custom implementation.
-
$queryString public @property-read
string
Method Summary
-
__construct() public
Constructor
-
__get() public
Magic getter to return $queryString as read-only.
-
_log() protected
Copies the logging data to the passed LoggedQuery and sends it to the logging system.
-
bind() public
Binds a set of values to statement object with corresponding type.
-
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.
-
columnCount() public
Returns the number of columns this statement's results will contain.
-
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.
-
fetch() public
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.
-
fetchAll() public
Returns an array with all rows resulting from executing this statement.
-
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.
-
fetchColumn() public
Returns the value of the result at position.
-
getInnerStatement() public
Returns the statement object that was decorated by this class.
-
getIterator() public
Statements are iterable as arrays, this method will return the iterator object for traversing all items in the result.
-
getLogger() public
Gets the logger object
-
lastInsertId() public
Returns the latest primary inserted using this statement.
-
logger() public deprecated
Sets the logger object instance. When called with no arguments it returns the currently setup logger instance
-
matchTypes() public
Matches columns to corresponding types
-
rowCount() public
Returns the number of rows affected by this SQL statement.
-
setLogger() public
Sets a logger
Method Detail
__construct() ¶ public
__construct(Cake\Database\StatementInterface|PDOStatement|null $statement = null, Cake\Database\Driver|null $driver = null)Constructor
Parameters
-
Cake\Database\StatementInterface|PDOStatement|null$statement optional Statement implementation such as PDOStatement
-
Cake\Database\Driver|null$driver optional Driver instance
__get() ¶ public
__get(string $property): mixedMagic 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): voidCopies 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$params List of values to be bound to query.
-
float$startTime The microtime when the query was executed.
Returns
voidbind() ¶ public
bind(array $params, array $types): voidBinds 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
Returns
voidbindValue() ¶ public
bindValue(string|int $column, mixed $value, string $type = 'string'): voidWrapper 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.
Examples:
$statement->bindValue(1, 'a title');
$statement->bindValue('active', true, 'boolean');
$statement->bindValue(5, new \DateTime(), 'date');Parameters
-
string|int$column Name or param position to be bound
-
mixed$value The value to bind to variable in query
-
string$type optional PDO type or name of configured Type class
Returns
voidcast() ¶ public
cast(mixed $value, Cake\Database\Type|string $type): arrayConverts 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
arraycloseCursor() ¶ public
closeCursor(): voidCloses 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.
Returns
voidcolumnCount() ¶ public
columnCount(): intReturns 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 2Returns
intcount() ¶ public
count(): intStatements can be passed as argument for count() to return the number for affected rows from last execution.
Returns
interrorCode() ¶ public
errorCode(): int|stringReturns the error code for the last error that occurred when executing this statement.
Returns
int|stringerrorInfo() ¶ public
errorInfo(): arrayReturns the error information for the last error that occurred when executing this statement.
Returns
arrayexecute() ¶ public
execute(array|null $params = null): boolWrapper 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
boolThrows
ExceptionRe-throws any exception raised during query execution.
fetch() ¶ public
fetch(string $type = self::FETCH_TYPE_NUM): array|falseReturns 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$type optional 'num' for positional columns, assoc for named columns
Returns
array|falsefetchAll() ¶ public
fetchAll(string $type = self::FETCH_TYPE_NUM): arrayReturns 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$type optional num for fetching columns as positional keys or assoc for column names as keys
Returns
arrayfetchAssoc() ¶ public
fetchAssoc(): arrayReturns 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
arrayfetchColumn() ¶ public
fetchColumn(int $position): mixedReturns the value of the result at position.
Parameters
-
int$position The numeric position of the column to retrieve in the result
Returns
mixedgetInnerStatement() ¶ public
getInnerStatement(): Cake\Database\StatementInterface|PDOStatementReturns the statement object that was decorated by this class.
Returns
Cake\Database\StatementInterface|PDOStatementgetIterator() ¶ public
getIterator(): Cake\Database\StatementInterface|PDOStatementStatements 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|PDOStatementgetLogger() ¶ public
getLogger(): Cake\Database\Log\QueryLoggerGets the logger object
Returns
Cake\Database\Log\QueryLoggerlastInsertId() ¶ public
lastInsertId(string|null $table = null, string|null $column = null): string|intReturns 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|intlogger() ¶ public
logger(Cake\Database\Log\QueryLogger|null $instance = null): Cake\Database\Log\QueryLogger|nullSets the logger object instance. When called with no arguments it returns the currently setup logger instance
Parameters
-
Cake\Database\Log\QueryLogger|null$instance optional Logger object instance.
Returns
Cake\Database\Log\QueryLogger|nullmatchTypes() ¶ public
matchTypes(array $columns, array $types): arrayMatches 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
arrayrowCount() ¶ public
rowCount(): intReturns 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 1Returns
intsetLogger() ¶ public
setLogger(Cake\Database\Log\QueryLogger $logger): voidSets a logger
Parameters
-
Cake\Database\Log\QueryLogger$logger Logger object
Returns
voidProperty Detail
$_driver ¶ protected
Reference to the driver object associated to this statement.
Type
Cake\Database\Driver|null$_logger ¶ protected
Logger instance responsible for actually doing the logging task
Type
Cake\Database\Log\QueryLogger|null$_statement ¶ protected
Statement instance implementation, such as PDOStatement or any other custom implementation.
Type
Cake\Database\StatementInterface|PDOStatement|null