Inheritance diagram for Zend_Db_Profiler:

Public Member Functions
	__construct ($enabled=false)

	setEnabled ($enable)

	getEnabled ()

	setFilterElapsedSecs ($minimumSeconds=null)

	getFilterElapsedSecs ()

	setFilterQueryType ($queryTypes=null)

	getFilterQueryType ()

	clear ()

	queryClone (Zend_Db_Profiler_Query $query)

	queryStart ($queryText, $queryType=null)

	queryEnd ($queryId)

	getQueryProfile ($queryId)

	getQueryProfiles ($queryType=null, $showUnfinished=false)

	getTotalElapsedSecs ($queryType=null)

	getTotalNumQueries ($queryType=null)

	getLastQueryProfile ()

Data Fields
const	CONNECT = 1

const	QUERY = 2

const	INSERT = 4

const	UPDATE = 8

const	DELETE = 16

const	SELECT = 32

const	TRANSACTION = 64

const	STORED = 'stored'

const	IGNORED = 'ignored'

Protected Attributes
	$_queryProfiles = array()

	$_enabled = false

	$_filterElapsedSecs = null

	$_filterTypes = null

Detailed Description

Definition at line 31 of file Profiler.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( $enabled = false )

Class constructor. The profiler is disabled by default unless it is specifically enabled by passing in $enabled here or calling setEnabled().

Parameters

boolean $enabled

Returns: void

Definition at line 124 of file Profiler.php.

     {
         $this->setEnabled($enabled);
     }

Member Function Documentation

◆ clear()

clear ( )

Clears the history of any past query profiles. This is relentless and will even clear queries that were started and may not have been marked as ended.

Returns: Zend_Db_Profiler Provides a fluent interface

Definition at line 220 of file Profiler.php.

     {
         $this->_queryProfiles = array();
 
         return $this;
     }

◆ getEnabled()

getEnabled ( )

Get the current state of enable. If True is returned, the profiler is enabled.

Returns: boolean

Definition at line 149 of file Profiler.php.

     {
         return $this->_enabled;
     }

◆ getFilterElapsedSecs()

getFilterElapsedSecs ( )

Returns the minimum number of seconds for saving query profiles, or null if query profiles are saved regardless of elapsed time.

Returns: integer|null

Definition at line 180 of file Profiler.php.

     {
         return $this->_filterElapsedSecs;
     }

◆ getFilterQueryType()

getFilterQueryType ( )

Returns the types of query profiles saved, or null if queries are saved regardless of their types.

Returns: integer|null

See also: Zend_Db_Profiler::setFilterQueryType()

Definition at line 208 of file Profiler.php.

     {
         return $this->_filterTypes;
     }

◆ getLastQueryProfile()

getLastQueryProfile ( )

Get the Zend_Db_Profiler_Query object for the last query that was run, regardless if it has ended or not. If the query has not ended, its end time will be null. If no queries have been profiled, false is returned.

Returns: Zend_Db_Profiler_Query|false

Definition at line 461 of file Profiler.php.

     {
         if (empty($this->_queryProfiles)) {
             return false;
         }
 
         end($this->_queryProfiles);
 
         return current($this->_queryProfiles);
     }

◆ getQueryProfile()

getQueryProfile ( $queryId )

Get a profile for a query. Pass it the same handle that was returned by queryStart() and it will return a Zend_Db_Profiler_Query object.

Parameters

integer $queryId

Exceptions

Zend_Db_Profiler_Exception

Returns: Zend_Db_Profiler_Query

See also: Zend_Db_Profiler_Exception

Definition at line 358 of file Profiler.php.

     {
         if (!array_key_exists($queryId, $this->_queryProfiles)) {
             #require_once 'Zend/Db/Profiler/Exception.php';
             throw new Zend_Db_Profiler_Exception("Query handle '$queryId' not found in profiler log.");
         }
 
         return $this->_queryProfiles[$queryId];
     }

◆ getQueryProfiles()

getQueryProfiles	(	$queryType = `null`,
		$showUnfinished = `false`
	)

Get an array of query profiles (Zend_Db_Profiler_Query objects). If $queryType is set to one of the Zend_Db_Profiler::* constants then only queries of that type will be returned. Normally, queries that have not yet ended will not be returned unless $showUnfinished is set to True. If no queries were found, False is returned. The returned array is indexed by the query profile handles.

Parameters

integer	$queryType
boolean	$showUnfinished

Returns: array|false

Definition at line 383 of file Profiler.php.

     {
         $queryProfiles = array();
         foreach ($this->_queryProfiles as $key => $qp) {
             if ($queryType === null) {
                 $condition = true;
             } else {
                 $condition = ($qp->getQueryType() & $queryType);
             }
 
             if (($qp->hasEnded() || $showUnfinished) && $condition) {
                 $queryProfiles[$key] = $qp;
             }
         }
 
         if (empty($queryProfiles)) {
             $queryProfiles = false;
         }
 
         return $queryProfiles;
     }

◆ getTotalElapsedSecs()

getTotalElapsedSecs ( $queryType = null )

Get the total elapsed time (in seconds) of all of the profiled queries. Only queries that have ended will be counted. If $queryType is set to one or more of the Zend_Db_Profiler::* constants, the elapsed time will be calculated only for queries of the given type(s).

Parameters

integer $queryType OPTIONAL

Returns: float

Definition at line 414 of file Profiler.php.

     {
         $elapsedSecs = 0;
         foreach ($this->_queryProfiles as $key => $qp) {
             if (null === $queryType) {
                 $condition = true;
             } else {
                 $condition = ($qp->getQueryType() & $queryType);
             }
             if (($qp->hasEnded()) && $condition) {
                 $elapsedSecs += $qp->getElapsedSecs();
             }
         }
         return $elapsedSecs;
     }

◆ getTotalNumQueries()

getTotalNumQueries ( $queryType = null )

Get the total number of queries that have been profiled. Only queries that have ended will be counted. If $queryType is set to one of the Zend_Db_Profiler::* constants, only queries of that type will be counted.

Parameters

integer $queryType OPTIONAL

Returns: integer

Definition at line 438 of file Profiler.php.

     {
         if (null === $queryType) {
             return count($this->_queryProfiles);
         }
 
         $numQueries = 0;
         foreach ($this->_queryProfiles as $qp) {
             if ($qp->hasEnded() && ($qp->getQueryType() & $queryType)) {
                 $numQueries++;
             }
         }
 
         return $numQueries;
     }

◆ queryClone()

queryClone ( Zend_Db_Profiler_Query $query )

Clone a profiler query

Parameters

Zend_Db_Profiler_Query $query

Returns: integer or null

Definition at line 233 of file Profiler.php.

     {
         $this->_queryProfiles[] = clone $query;
 
         end($this->_queryProfiles);
 
         return key($this->_queryProfiles);
     }

◆ queryEnd()

queryEnd ( $queryId )

Ends a query. Pass it the handle that was returned by queryStart(). This will mark the query as ended and save the time.

Parameters

integer $queryId

Exceptions

Zend_Db_Profiler_Exception

Returns: string Inform that a query is stored or ignored.

See also: Zend_Db_Profiler_Exception; Zend_Db_Profiler_Exception

If filtering by elapsed time is enabled, only keep the profile if it ran for the minimum time.

If filtering by query type is enabled, only keep the query if it was one of the allowed types.

Definition at line 299 of file Profiler.php.

     {
         // Don't do anything if the Zend_Db_Profiler is not enabled.
         if (!$this->_enabled) {
             return self::IGNORED;
         }
 
         // Check for a valid query handle.
         if (!isset($this->_queryProfiles[$queryId])) {
             #require_once 'Zend/Db/Profiler/Exception.php';
             throw new Zend_Db_Profiler_Exception("Profiler has no query with handle '$queryId'.");
         }
 
         $qp = $this->_queryProfiles[$queryId];
 
         // Ensure that the query profile has not already ended
         if ($qp->hasEnded()) {
             #require_once 'Zend/Db/Profiler/Exception.php';
             throw new Zend_Db_Profiler_Exception("Query with profiler handle '$queryId' has already ended.");
         }
 
         // End the query profile so that the elapsed time can be calculated.
         $qp->end();
 
         if (null !== $this->_filterElapsedSecs && $qp->getElapsedSecs() < $this->_filterElapsedSecs) {
             unset($this->_queryProfiles[$queryId]);
             return self::IGNORED;
         }
 
         if (null !== $this->_filterTypes && !($qp->getQueryType() & $this->_filterTypes)) {
             unset($this->_queryProfiles[$queryId]);
             return self::IGNORED;
         }
 
         return self::STORED;
     }

◆ queryStart()

queryStart	(	$queryText,
		$queryType = `null`
	)

Starts a query. Creates a new query profile object (Zend_Db_Profiler_Query) and returns the "query profiler handle". Run the query, then call queryEnd() and pass it this handle to make the query as ended and record the time. If the profiler is not enabled, this takes no action and immediately returns null.

Parameters

string	$queryText	SQL statement
integer	$queryType	OPTIONAL Type of query, one of the Zend_Db_Profiler::* constants

Returns: integer|null

See also: Zend_Db_Profiler_Query

Definition at line 253 of file Profiler.php.

     {
         if (!$this->_enabled) {
             return null;
         }
 
         // make sure we have a query type
         if (null === $queryType) {
             switch (strtolower(substr(ltrim($queryText), 0, 6))) {
                 case 'insert':
                     $queryType = self::INSERT;
                     break;
                 case 'update':
                     $queryType = self::UPDATE;
                     break;
                 case 'delete':
                     $queryType = self::DELETE;
                     break;
                 case 'select':
                     $queryType = self::SELECT;
                     break;
                 default:
                     $queryType = self::QUERY;
                     break;
             }
         }
 
         #require_once 'Zend/Db/Profiler/Query.php';
         $this->_queryProfiles[] = new Zend_Db_Profiler_Query($queryText, $queryType);
 
         end($this->_queryProfiles);
 
         return key($this->_queryProfiles);
     }

◆ setEnabled()

setEnabled ( $enable )

Enable or disable the profiler. If $enable is false, the profiler is disabled and will not log any queries sent to it.

Parameters

boolean $enable

Returns: Zend_Db_Profiler Provides a fluent interface

Definition at line 136 of file Profiler.php.

     {
         $this->_enabled = (boolean) $enable;
 
         return $this;
     }

◆ setFilterElapsedSecs()

setFilterElapsedSecs ( $minimumSeconds = null )

Sets a minimum number of seconds for saving query profiles. If this is set, only those queries whose elapsed time is equal or greater than $minimumSeconds will be saved. To save all queries regardless of elapsed time, set $minimumSeconds to null.

Parameters

integer $minimumSeconds OPTIONAL

Returns: Zend_Db_Profiler Provides a fluent interface

Definition at line 163 of file Profiler.php.

     {
         if (null === $minimumSeconds) {
             $this->_filterElapsedSecs = null;
         } else {
             $this->_filterElapsedSecs = (integer) $minimumSeconds;
         }
 
         return $this;
     }

◆ setFilterQueryType()

setFilterQueryType ( $queryTypes = null )

Sets the types of query profiles to save. Set $queryType to one of the Zend_Db_Profiler::* constants to only save profiles for that type of query. To save more than one type, logical OR them together. To save all queries regardless of type, set $queryType to null.

Parameters

integer $queryTypes OPTIONAL

Returns: Zend_Db_Profiler Provides a fluent interface

Definition at line 194 of file Profiler.php.

     {
         $this->_filterTypes = $queryTypes;
 
         return $this;
     }

Field Documentation

◆ $_enabled

$_enabled = false

protected

Definition at line 94 of file Profiler.php.

◆ $_filterElapsedSecs

$_filterElapsedSecs = null

protected

Definition at line 104 of file Profiler.php.

◆ $_filterTypes

$_filterTypes = null

protected

Definition at line 115 of file Profiler.php.

◆ $_queryProfiles

$_queryProfiles = array()

protected

Definition at line 86 of file Profiler.php.

◆ CONNECT

const CONNECT = 1

A connection operation or selecting a database.

Definition at line 37 of file Profiler.php.

◆ DELETE

const DELETE = 16

An operation related to deleting data in the database, such as SQL's DELETE.

Definition at line 59 of file Profiler.php.

◆ IGNORED

const IGNORED = 'ignored'

Inform that a query is ignored (in case of filtering)

Definition at line 79 of file Profiler.php.

◆ INSERT

const INSERT = 4

Adding new data to the database, such as SQL's INSERT.

Definition at line 47 of file Profiler.php.

◆ QUERY

const QUERY = 2

Any general database query that does not fit into the other constants.

Definition at line 42 of file Profiler.php.

◆ SELECT

const SELECT = 32

Retrieving information from the database, such as SQL's SELECT.

Definition at line 64 of file Profiler.php.

◆ STORED

const STORED = 'stored'

Inform that a query is stored (in case of filtering)

Definition at line 74 of file Profiler.php.

◆ TRANSACTION

const TRANSACTION = 64

Transactional operation, such as start transaction, commit, or rollback.

Definition at line 69 of file Profiler.php.

◆ UPDATE

const UPDATE = 8

Updating existing information in the database, such as SQL's UPDATE.

Definition at line 53 of file Profiler.php.

The documentation for this class was generated from the following file:

vendor/magento/zendframework1/library/Zend/Db/Profiler.php

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ clear()

◆ getEnabled()

◆ getFilterElapsedSecs()

◆ getFilterQueryType()

◆ getLastQueryProfile()

◆ getQueryProfile()

◆ getQueryProfiles()

◆ getTotalElapsedSecs()

◆ getTotalNumQueries()

◆ queryClone()

◆ queryEnd()

◆ queryStart()

◆ setEnabled()

◆ setFilterElapsedSecs()

◆ setFilterQueryType()

Field Documentation

◆ $_enabled

◆ $_filterElapsedSecs

◆ $_filterTypes

◆ $_queryProfiles

◆ CONNECT

◆ DELETE

◆ IGNORED

◆ INSERT

◆ QUERY

◆ SELECT

◆ STORED

◆ TRANSACTION

◆ UPDATE