Zend_Db_Profiler_Query Class Reference

Public Member Functions
	__construct ($query, $queryType)
	__clone ()
	start ()
	end ()
	hasEnded ()
	getQuery ()
	getQueryType ()
	bindParam ($param, $variable)
	bindParams (array $params)
	getQueryParams ()
	getElapsedSecs ()
	getStartedMicrotime ()

Protected Attributes
	$_query = ''
	$_queryType = 0
	$_startedMicrotime = null
	$_endedMicrotime = null
	$_boundParams = array()

Detailed Description

Definition at line 31 of file Query.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$query,
			$queryType
	)

Class constructor. A query is about to be started, save the query text ($query) and its type (one of the Zend_Db_Profiler::* constants).

Parameters

string	$query
integer	$queryType

Returns

void

Definition at line 79 of file Query.php.

    {
        $this->_query = $query;
        $this->_queryType = $queryType;
        // by default, and for backward-compatibility, start the click ticking
        $this->start();
    }

Member Function Documentation

__clone()

__clone

(

)

Clone handler for the query object.

Returns

void

Definition at line 91 of file Query.php.

    {
        $this->_boundParams = array();
        $this->_endedMicrotime = null;
        $this->start();
    }

bindParam()

bindParam	(		$param,
			$variable
	)

Parameters

string	$param
mixed	$variable

Returns

void

Definition at line 156 of file Query.php.

    {
        $this->_boundParams[$param] = $variable;
    }

bindParams()

bindParams

(

array

$params

)

Parameters

array

$param

Returns

void

Definition at line 165 of file Query.php.

    {
        if (array_key_exists(0, $params)) {
            array_unshift($params, null);
            unset($params[0]);
        }
        foreach ($params as $param => $value) {
            $this->bindParam($param, $value);
        }
    }

end()

end

(

)

Ends the query and records the time so that the elapsed time can be determined later.

Returns

void

Definition at line 116 of file Query.php.

    {
        $this->_endedMicrotime = microtime(true);
    }

getElapsedSecs()

getElapsedSecs

(

)

Get the elapsed time (in seconds) that the query ran. If the query has not yet ended, false is returned.

Returns

float|false

Definition at line 190 of file Query.php.

    {
        if (null === $this->_endedMicrotime) {
            return false;
        }

        return $this->_endedMicrotime - $this->_startedMicrotime;
    }

getQuery()

getQuery

(

)

Get the original SQL text of the query.

Returns

string

Definition at line 136 of file Query.php.

    {
        return $this->_query;
    }

getQueryParams()

getQueryParams

(

)

Returns

array

Definition at line 179 of file Query.php.

    {
        return $this->_boundParams;
    }

getQueryType()

getQueryType

(

)

Get the type of this query (one of the Zend_Db_Profiler::* constants)

Returns

integer

Definition at line 146 of file Query.php.

    {
        return $this->_queryType;
    }

getStartedMicrotime()

getStartedMicrotime

(

)

Get the time (in seconds) when the profiler started running.

Returns

bool|float

Definition at line 204 of file Query.php.

    {
        if(null === $this->_startedMicrotime) {
            return false;
        }

        return $this->_startedMicrotime;
    }

hasEnded()

hasEnded

(

)

Returns true if and only if the query has ended.

Returns

boolean

Definition at line 126 of file Query.php.

    {
        return $this->_endedMicrotime !== null;
    }

start()

start

(

)

Starts the elapsed time click ticking. This can be called subsequent to object creation, to restart the clock. For instance, this is useful right before executing a prepared query.

Returns

void

Definition at line 106 of file Query.php.

    {
        $this->_startedMicrotime = microtime(true);
    }

Field Documentation

$_boundParams

$_boundParams = array()

protected

Definition at line 65 of file Query.php.

$_endedMicrotime

$_endedMicrotime = null

protected

Definition at line 60 of file Query.php.

$_query

$_query = ''

protected

Definition at line 39 of file Query.php.

$_queryType

$_queryType = 0

protected

Definition at line 46 of file Query.php.

$_startedMicrotime

$_startedMicrotime = null

protected

Definition at line 53 of file Query.php.

---

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

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