Class Zend_Db_Profiler

Description
  • copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Db/Profiler.php (line 32)


	
			
Class Constant Summary
 CONNECT = 1
 DELETE = 16
 INSERT = 4
 QUERY = 2
 SELECT = 32
 UPDATE = 8
Variable Summary
Method Summary
 void __construct ([boolean $enabled = false])
 boolean getEnabled ()
 integer|null getFilterElapsedSecs ()
 integer|null getFilterQueryType ()
 array|false getQueryProfiles ([integer $queryType = null], [boolean $showUnfinished = false])
 float getTotalElapsedSecs ([integer $queryType = null])
 integer getTotalNumQueries ([integer $queryType = null])
 void queryEnd (integer $queryId)
 integer|null queryStart (string $queryText, [integer $queryType = null])
 Zend_Db_Profiler setEnabled (boolean $enable)
 Zend_Db_Profiler setFilterElapsedSecs ([integer $minimumSeconds = null])
 Zend_Db_Profiler setFilterQueryType ([integer $queryTypes = null])
Variables
boolean $_enabled = false (line 86)

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

  • access: protected
integer $_filterElapsedSecs = null (line 96)

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.

  • access: protected
integer $_filterTypes = null (line 107)

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.

  • access: protected
array $_queryProfiles = array() (line 78)

Array of Zend_Db_Profiler_Query objects.

  • access: protected
Methods
clear (line 212)

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.

  • return: Provides a fluent interface
  • access: public
Zend_Db_Profiler clear ()
Constructor __construct (line 116)

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

  • access: public
void __construct ([boolean $enabled = false])
  • boolean $enabled
getEnabled (line 141)

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

  • access: public
boolean getEnabled ()
getFilterElapsedSecs (line 172)

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

  • access: public
integer|null getFilterElapsedSecs ()
getFilterQueryType (line 200)

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

integer|null getFilterQueryType ()
getLastQueryProfile (line 436)

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.

  • access: public
Zend_Db_Profiler_Query|false getLastQueryProfile ()
getQueryProfile (line 333)

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.

  • throws: Zend_Db_Profiler_Exception
  • access: public
Zend_Db_Profiler_Query getQueryProfile (integer $queryId)
  • integer $queryId
getQueryProfiles (line 358)

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.

  • access: public
array|false getQueryProfiles ([integer $queryType = null], [boolean $showUnfinished = false])
  • integer $queryType
  • boolean $showUnfinished
getTotalElapsedSecs (line 389)

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).

  • access: public
float getTotalElapsedSecs ([integer $queryType = null])
  • integer $queryType: OPTIONAL
getTotalNumQueries (line 413)

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.

  • access: public
integer getTotalNumQueries ([integer $queryType = null])
  • integer $queryType: OPTIONAL
queryEnd (line 276)

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

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

  • throws: Zend_Db_Profiler_Exception
  • access: public
void queryEnd (integer $queryId)
  • integer $queryId
queryStart (line 230)

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.

  • access: public
integer|null queryStart (string $queryText, [integer $queryType = null])
  • string $queryText: SQL statement
  • integer $queryType: OPTIONAL Type of query, one of the Zend_Db_Profiler::* constants
setEnabled (line 128)

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

  • return: Provides a fluent interface
  • access: public
Zend_Db_Profiler setEnabled (boolean $enable)
  • boolean $enable
setFilterElapsedSecs (line 155)

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.

  • return: Provides a fluent interface
  • access: public
Zend_Db_Profiler setFilterElapsedSecs ([integer $minimumSeconds = null])
  • integer $minimumSeconds: OPTIONAL
setFilterQueryType (line 186)

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.

  • return: Provides a fluent interface
  • access: public
Zend_Db_Profiler setFilterQueryType ([integer $queryTypes = null])
  • integer $queryTypes: OPTIONAL
Class Constants
CONNECT = 1 (line 38)

A connection operation or selecting a database.

DELETE = 16 (line 60)

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

INSERT = 4 (line 48)

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

QUERY = 2 (line 43)

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

SELECT = 32 (line 65)

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

TRANSACTION = 64 (line 70)

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

UPDATE = 8 (line 54)

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

Documentation generated on Sun, 27 May 2007 23:26:50 -0700 by phpDocumentor 1.3.2