Db/Profiler.php

Show:

inherited

Classes
- \Zend_Db_Profiler

Table of Contents

Zend Framework

LICENSE This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Db
Subpackage: Profiler
Version: $Id$

\Zend_Db_Profiler
jump to top

Package: Zend_Db\Profiler

Children: \Zend_Db_Profiler_Firebug
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                CONNECT
                = 1

A connection operation or selecting a database.

 
                QUERY
                = 2

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

 
                INSERT
                = 4

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

 
                UPDATE
                = 8

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

 
                DELETE
                = 16

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

 
                SELECT
                = 32

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

 
                TRANSACTION
                = 64

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

 
                STORED
                = 'stored'

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

 
                IGNORED
                = 'ignored'

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

Properties

boolean $_enabled = false

Stores enabled state of the profiler. If set to False, calls to queryStart() will simply be ignored.

Default valuefalseDetails

Type: boolean

integer $_filterElapsedSecs = null

Stores the number of seconds to filter. NULL if filtering by time is disabled. If an integer is stored here, profiles whose elapsed time is less than this value in seconds will be unset from the self::$_queryProfiles array.

Default valuenullDetails

Type: integer

integer $_filterTypes = null

Logical OR of any of the filter constants. NULL if filtering by query type is disable. If an integer is stored here, it is the logical OR of any of the query type constants. When the query ends, if it is not one of the types specified, it will be unset from the self::$_queryProfiles array.

Default valuenullDetails

Type: integer

array $_queryProfiles = array()

Array of Zend_Db_Profiler_Query objects.

Default valuearray()Details

Type: array

Methods

__construct(boolean $enabled = false) : void

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

Parameters

Name	Type	Description
$enabled	boolean

clear() : \Zend_Db_Profiler

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

Type	Description
\Zend_Db_Profiler	Provides a fluent interface

getEnabled() : boolean

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

Returns

Type	Description
boolean

getFilterElapsedSecs() : integer | null

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

Returns

Type	Description
integer \| null

getFilterQueryType() : integer | null

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

Returns

Type	Description
integer \| null

Details

See

getLastQueryProfile() : \Zend_Db_Profiler_Query | false

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

Type	Description
\Zend_Db_Profiler_Query \| false

getQueryProfile(integer $queryId) : \Zend_Db_Profiler_Query

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

Name	Type	Description
$queryId	integer

Returns

Type	Description
\Zend_Db_Profiler_Query

Throws

Exception	Description
\Zend_Db_Profiler_Exception

getQueryProfiles(integer $queryType = null, boolean $showUnfinished = false) : array | 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

Name	Type	Description
$queryType	integer
$showUnfinished	boolean

Returns

Type	Description
array \| false

getTotalElapsedSecs(integer $queryType = null) : float

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

Name	Type	Description
$queryType	integer	OPTIONAL

Returns

Type	Description
float

getTotalNumQueries(integer $queryType = null) : integer

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

Name	Type	Description
$queryType	integer	OPTIONAL

Returns

Type	Description
integer

queryClone(\Zend_Db_Profiler_Query $query) : integer

Clone a profiler query

Parameters

Name	Type	Description
$query	\Zend_Db_Profiler_Query

Returns

Type	Description
integer	or null

queryEnd(integer $queryId) : string

Ends a query. Pass it the handle that was returned by queryStart().

This will mark the query as ended and save the time.

Parameters

Name	Type	Description
$queryId	integer

Returns

Type	Description
string	Inform that a query is stored or ignored.

Throws

Exception	Description
\Zend_Db_Profiler_Exception

queryStart(string $queryText, integer $queryType = null) : integer | 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

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

Returns

Type	Description
integer \| null

setEnabled(boolean $enable) : \Zend_Db_Profiler

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

Parameters

Name	Type	Description
$enable	boolean

Returns

Type	Description
\Zend_Db_Profiler	Provides a fluent interface

setFilterElapsedSecs(integer $minimumSeconds = null) : \Zend_Db_Profiler

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

Name	Type	Description
$minimumSeconds	integer	OPTIONAL

Returns

Type	Description
\Zend_Db_Profiler	Provides a fluent interface

setFilterQueryType(integer $queryTypes = null) : \Zend_Db_Profiler

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

Name	Type	Description
$queryTypes	integer	OPTIONAL

Returns

Type	Description
\Zend_Db_Profiler	Provides a fluent interface

Db/Profiler.php

\Zend_Db_Profilerjump to top

Constants

Properties

Methods

\Zend_Db_Profiler
jump to top