Profiler Class Reference

Inheritance diagram for Profiler:

Public Member Functions
	queryStart ($queryText, $queryType=null)
Public Member Functions inherited from Profiler
	setHost ($host)
	setType ($type)
	queryStart ($queryText, $queryType=null)
	queryEnd ($queryId)
	queryEndLast ()
Public Member Functions inherited from Zend_Db_Profiler
	__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	TIMER_PREFIX = 'DB_QUERY'
const	DEFAULT_CONNECTION_TYPE = 'database'
Data Fields inherited from Zend_Db_Profiler
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 Member Functions
	_getTimerName ($operation)
	_parseQueryType ($queryText)

Protected Attributes
	$_queryTypes = ['select', 'insert', 'update', 'delete']
Protected Attributes inherited from Profiler
	$_host = ''
	$_type = ''
Protected Attributes inherited from Zend_Db_Profiler
	$_queryProfiles = array()
	$_enabled = false
	$_filterElapsedSecs = null
	$_filterTypes = null

Detailed Description

Definition at line 10 of file Profiler.php.

Member Function Documentation

_getTimerName()

_getTimerName (   $operation )

protected

Form and return timer name

Parameters

string

$operation

Returns

string

Definition at line 33 of file Profiler.php.

    {
        // default name of connection type
        $timerName = \Magento\Framework\Model\ResourceModel\Db\Profiler::DEFAULT_CONNECTION_TYPE;

        // connection type to database
        if (!empty($this->_type)) {
            $timerName = $this->_type;
        }

        // sql operation
        $timerName .= '_' . $operation;

        // database host
        if (!empty($this->_host)) {
            $timerName .= '_' . $this->_host;
        }

        return \Magento\Framework\Model\ResourceModel\Db\Profiler::TIMER_PREFIX . ':' . $timerName;
    }

_parseQueryType()

_parseQueryType (   $queryText )

protected

Parse query type and return

Parameters

string

$queryText

Returns

string

Definition at line 60 of file Profiler.php.

    {
        $queryTypeParsed = strtolower(substr(ltrim($queryText), 0, 6));

        if (!in_array($queryTypeParsed, $this->_queryTypes)) {
            $queryTypeParsed = 'query';
        }

        return $queryTypeParsed;
    }

queryStart()

queryStart	(		$queryText,
			$queryType = null
	)

Starts a query. Creates a new query profile object (\Zend_Db_Profiler_Query)

Parameters

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

Returns

integer|null

Definition at line 78 of file Profiler.php.

    {
        $result = parent::queryStart($queryText, $queryType);

        if ($result !== null) {
            $queryTypeParsed = $this->_parseQueryType($queryText);
            $timerName = $this->_getTimerName($queryTypeParsed);

            $tags = [];

            // connection type to database
            $typePrefix = '';
            if ($this->_type) {
                $tags['group'] = $this->_type;
                $typePrefix = $this->_type . ':';
            }

            // sql operation
            $tags['operation'] = $typePrefix . $queryTypeParsed;

            // database host
            if ($this->_host) {
                $tags['host'] = $this->_host;
            }

            \Magento\Framework\Profiler::start($timerName, $tags);
        }

        return $result;
    }

Field Documentation

$_queryTypes

$_queryTypes = ['select', 'insert', 'update', 'delete']

protected

Definition at line 25 of file Profiler.php.

DEFAULT_CONNECTION_TYPE

const DEFAULT_CONNECTION_TYPE = 'database'

Default connection type for timer name creation

Definition at line 20 of file Profiler.php.

TIMER_PREFIX

const TIMER_PREFIX = 'DB_QUERY'

Default connection type for timer name creation

Definition at line 15 of file Profiler.php.

---

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

• vendor/magento/framework/Model/ResourceModel/Db/Profiler.php