query-log doc
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Namespaces

  • Phramework
    • QueryLog

Classes

  • QueryLog
  • QueryLogAdapter

Class QueryLogAdapter

QueryLogAdapter is an implementation of IAdapter which uses an existing adapter to execute the called methods while logging the query in a different adapter.

Phramework\QueryLog\QueryLogAdapter implements Phramework\Database\IAdapter
Namespace: Phramework\QueryLog
License: Apache-2.0
Author: Xenofon Spafaridis nohponex@gmail.com
Located at QueryLogAdapter.php

Methods summary

public
# __construct( array $settings, Phramework\Phramework\Database\IAdapter $internalAdapter, null|object|array $additionalParameters = null )

Parameters

$settings
Settings array
$internalAdapter
Current database adapter
$additionalParameters
Additional parameters to store in log

Throws

Exception

Todo

Remove typecast to array when log adapters will accept objects
protected
# log( string $query, array $parameters, integer $startTimestamp, null|Exception $exception = null )

Log query to database

Log query to database

Parameters

$query
$parameters
Query parameters
$startTimestamp
Timestamp before query was executed
$exception
[Optional] Exception object if any
public string
# getAdapterName( )

Get adapter's name

Get adapter's name

Returns

string
Adapter's name
public integer
# execute( string $query, array $parameters = [] )

Execute a query and return the row count

Execute a query and return the row count

Parameters

$query
$parameters
Query parameters

Returns

integer
Returns the number of rows affected or selected

Throws

Phramework\Phramework\Exceptions\DatabaseException
public integer
# executeLastInsertId( string $query, array $parameters = [] )

Execute a query and return last instert id

Execute a query and return last instert id

Parameters

$query
$parameters
Query parameters

Returns

integer
Returns the id of last inserted record

Throws

Phramework\Phramework\Exceptions\DatabaseException
public array
# executeAndFetch( string $query, array $parameters = [], array $castModel = null )

Execute a query and fetch first row as associative array

Execute a query and fetch first row as associative array

Parameters

$query
$parameters
Query parameters
$castModel
[Optional] Default is null, if set then

Returns

array
Returns a single row

Throws

Phramework\Phramework\Exceptions\DatabaseException
public array[]
# executeAndFetchAll( string $query, array $parameters = [], array $castModel = null )

Execute a query and fetch all rows as associative array

Execute a query and fetch all rows as associative array

Parameters

$query
$parameters
Query parameters
$castModel
[Optional] Default is null

Returns

array[]

Throws

Phramework\Phramework\Exceptions\DatabaseException
public array
# executeAndFetchArray( string $query, array $parameters = [] )

Execute a query and fetch first row as array

Execute a query and fetch first row as array

Parameters

$query
$parameters
Query parameters

Returns

array

Throws

Phramework\Phramework\Exceptions\DatabaseException
public array[]
# executeAndFetchAllArray( string $query, array $parameters = [] )

Parameters

$query
Query string
$parameters
Query parameters

Returns

array[]

Throws

Phramework\Phramework\Exceptions\DatabaseException
public mixed
# bindExecuteLastInsertId( string $query, array $parameters = [] )

Bind Execute a query and return last instert id

Bind Execute a query and return last instert id

Parameters

$query
Query string
$parameters
parameters

Returns

mixed

Throws

Phramework\Phramework\Exceptions\DatabaseException
public integer
# bindExecute( string $query, array $parameters = [] )

Bind Execute a query and return the row count

Bind Execute a query and return the row count

Parameters

$query
Query string
$parameters
Query parameters

Returns

integer

Throws

Phramework\Phramework\Exceptions\DatabaseException

Todo

provide documentation
public array
# bindExecuteAndFetch( string $query, array $parameters = [], array $castModel = null )

Bind Execute a query and fetch first row as associative array

Bind Execute a query and fetch first row as associative array

Parameters

$query
Query string
$parameters
Query parameters
$castModel

[Optional] Default is null, if set then \Phramework\Models\Filter::castEntry will be applied to data

Returns

array

Throws

Phramework\Phramework\Exceptions\DatabaseException
public array[]
# bindExecuteAndFetchAll( string $query, array $parameters = [], array $castModel = null )

Bind Execute a query and fetch all rows as associative array

Bind Execute a query and fetch all rows as associative array

Parameters

$query
Query string
$parameters
Query parameters
$castModel

[Optional] Default is null, if set then \Phramework\Models\Filter::castEntry will be applied to data

Returns

array[]

Throws

Phramework\Phramework\Exceptions\DatabaseException
public
# close( )

Close the connection to database

Close the connection to database

Constants summary

string LOG_INGORED
# 'IGNORED'

Properties summary

protected Phramework\Database\IAdapter $logAdapter
#
protected Phramework\Database\IAdapter $internalAdapter
#
protected null|array|object $additionalParameters
#
protected null|string $schema

Table's schema, null if default is used

Table's schema, null if default is used
# null
protected string $table

Table's name

Table's name
# 'query_log'
protected object $matrix

Log level matrix

Log level matrix
#
query-log doc API documentation generated by ApiGen