W3cubDocs

/CakePHP 4.4

Class LoggingStatement

Statement decorator used to

Namespace: Cake\Database\Log

Constants

  • string
    FETCH_TYPE_ASSOC 
    'assoc'

    Used to designate that an associated array be returned in a result when calling fetch methods

  • string
    FETCH_TYPE_NUM 
    'num'

    Used to designate that numeric indexes be returned in a result when calling fetch methods

  • string
    FETCH_TYPE_OBJ 
    'obj'

    Used to designate that a stdClass object be returned in a result when calling fetch methods

Property Summary

  • $_compiledParams protected
    array<array>

    Holds bound params

  • $_driver protected
    Cake\Database\DriverInterface

    Reference to the driver object associated to this statement.

  • $_hasExecuted protected
    bool

    Whether 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.

  • $loggedQuery protected
    Cake\Database\Log\LoggedQuery|null

    Logged query

  • $queryString public @property-read
    string
  • $startTime protected
    float

    Query execution start time.

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 an empty array 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.

  • 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 $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): string|null

Magic getter to return $queryString as read-only.

Parameters

string $property

internal property to get

Returns

string|null

_log() protected 

_log(): void

Copies the logging data to the passed LoggedQuery and sends it to the logging system.

Returns

void

bind() public 

bind(array $params, array $types): void

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

Returns

void

bindValue() public 

bindValue(string|int $column, mixed $value, string|int|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.

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|int|null $type optional

PDO type or name of configured Type class

Returns

void

cast() public 

cast(mixed $value, Cake\Database\TypeInterface|string|int $type = 'string'): array

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

closeCursor() public 

closeCursor(): void

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.

Returns

void

columnCount() public 

columnCount(): int

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(): int

Statements can be passed as argument for count() to return the number for affected rows from last execution.

Returns

int

errorCode() public 

errorCode(): string|int

Returns the error code for the last error that occurred when executing this statement.

Returns

string|int

errorInfo() public 

errorInfo(): array

Returns the error information for the last error that occurred when executing this statement.

Returns

array

execute() public 

execute(array|null $params = null): bool

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

Throws

Exception
Re-throws any exception raised during query execution.

fetch() public 

fetch(string|int $type = self::FETCH_TYPE_NUM): mixed

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

Returns

mixed

fetchAll() public 

fetchAll(string|int $type = self::FETCH_TYPE_NUM): array|false

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

Returns

array|false

fetchAssoc() public 

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 an empty array is returned.

Returns

array

fetchColumn() public 

fetchColumn(int $position): mixed

Returns the value of the result at position.

Parameters

int $position

The numeric position of the column to retrieve in the result

Returns

mixed

getInnerStatement() public 

getInnerStatement(): Cake\Database\StatementInterface

Returns the statement object that was decorated by this class.

Returns

Cake\Database\StatementInterface

getIterator() public 

getIterator(): Cake\Database\StatementInterface

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(): Psr\Log\LoggerInterface

Gets the logger object

Returns

Psr\Log\LoggerInterface

lastInsertId() public 

lastInsertId(string|null $table = null, string|null $column = null): string|int

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): array

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(): int

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): void

Sets a logger

Parameters

Psr\Log\LoggerInterface $logger

Logger object

Returns

void

Property Detail

$_compiledParams protected

Holds bound params

Type

array<array>

$_driver protected

Reference to the driver object associated to this statement.

Type

Cake\Database\DriverInterface

$_hasExecuted protected

Whether 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

$loggedQuery protected

Logged query

Type

Cake\Database\Log\LoggedQuery|null

$queryString public @property-read

Type

string

$startTime protected

Query execution start time.

Type

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.4/class-Cake.Database.Log.LoggingStatement.html