Public Member Functions | Data Fields | Protected Attributes

Zend_Db_Profiler Class Reference

Inheritance diagram for Zend_Db_Profiler:
Zend_Db_Profiler_Firebug

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

Protected Attributes

 $_queryProfiles = array()
 $_enabled = false
 $_filterElapsedSecs = null
 $_filterTypes = null

Detailed Description

Definition at line 31 of file Profiler.php.


Constructor & Destructor Documentation

__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

Reimplemented in Zend_Db_Profiler_Firebug.

Definition at line 115 of file Profiler.php.


Member Function Documentation

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 211 of file Profiler.php.

getEnabled (  )

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

Returns:
boolean

Definition at line 140 of file Profiler.php.

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 171 of file Profiler.php.

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 199 of file Profiler.php.

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 448 of file Profiler.php.

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 345 of file Profiler.php.

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 370 of file Profiler.php.

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$queryTypeOPTIONAL
Returns:
float

Definition at line 401 of file Profiler.php.

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$queryTypeOPTIONAL
Returns:
integer

Definition at line 425 of file Profiler.php.

queryClone ( Zend_Db_Profiler_Query query )
Parameters:
integer$queryId
Returns:
integer or null

Definition at line 222 of file Profiler.php.

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:
void

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.

Reimplemented in Zend_Db_Profiler_Firebug.

Definition at line 288 of file Profiler.php.

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$queryTextSQL statement
integer$queryTypeOPTIONAL Type of query, one of the Zend_Db_Profiler::* constants
Returns:
integer|null

See also:
Zend_Db_Profiler_Query

Definition at line 242 of file Profiler.php.

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

Reimplemented in Zend_Db_Profiler_Firebug.

Definition at line 127 of file Profiler.php.

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$minimumSecondsOPTIONAL
Returns:
Zend_Db_Profiler Provides a fluent interface

Definition at line 154 of file Profiler.php.

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$queryTypesOPTIONAL
Returns:
Zend_Db_Profiler Provides a fluent interface

Definition at line 185 of file Profiler.php.


Field Documentation

const CONNECT = 1

A connection operation or selecting a database.

Definition at line 37 of file Profiler.php.

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.

const INSERT = 4

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

Definition at line 47 of file Profiler.php.

const QUERY = 2

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

Definition at line 42 of file Profiler.php.

const SELECT = 32

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

Definition at line 64 of file Profiler.php.

const TRANSACTION = 64

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

Definition at line 69 of file Profiler.php.

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: