API Documentation

Db/Profiler/Firebug.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Db  
subpackage
Profiler  
version
$Id: Firebug.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Db_Profiler_Firebug

Writes DB events as log messages to the Firebug Console via FirePHP.

Extends from
\Zend_Db_Profiler
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Db  
subpackage
Profiler  

Properties

Propertyprotectedstring  $_label= 'null'

The original label for this profiler.

Default valuenullDetails
Type
string
Propertyprotectedstring  $_label_template= '%label% (%totalCount% @ %totalDuration% sec)'

The label template for this profiler

Default value%label% (%totalCount% @ %totalDuration% sec)Details
Type
string
Propertyprotected\Zend_Wildfire_Plugin_FirePhp_TableMessage  $_message= 'null'

The message envelope holding the profiling summary

Default valuenullDetails
Type
\Zend_Wildfire_Plugin_FirePhp_TableMessage
Propertyprotectedfloat  $_totalElapsedTime= '0'

The total time taken for all profiled queries.

Default value0Details
Type
float

Methods

methodpublic__construct( string $label = null ) : void

Constructor

Parameters
Name Type Description
$label string OPTIONAL Label for the profiling info.
methodpublicclear( ) : \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.

Inherited from: \Zend_Db_Profiler::clear()
Returns
Type Description
\Zend_Db_Profiler Provides a fluent interface
methodpublicgetEnabled( ) : boolean

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

Inherited from: \Zend_Db_Profiler::getEnabled()
Returns
Type Description
boolean
methodpublicgetFilterElapsedSecs( ) : integer|null

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

Inherited from: \Zend_Db_Profiler::getFilterElapsedSecs()
Returns
Type Description
integernull
methodpublicgetFilterQueryType( ) : integer|null

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

Inherited from: \Zend_Db_Profiler::getFilterQueryType()
Returns
Type Description
integernull
Details
see
\Zend_Db_Profiler::setFilterQueryType()  
methodpublicgetLastQueryProfile( ) : \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.

Inherited from: \Zend_Db_Profiler::getLastQueryProfile()
Returns
Type Description
\Zend_Db_Profiler_Queryfalse
methodpublicgetQueryProfile( 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.

Inherited from: \Zend_Db_Profiler::getQueryProfile()
Parameters
Name Type Description
$queryId integer
Returns
Type Description
\Zend_Db_Profiler_Query
Throws
Exception Description
\Zend_Db_Profiler_Exception
methodpublicgetQueryProfiles( 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.

Inherited from: \Zend_Db_Profiler::getQueryProfiles()
Parameters
Name Type Description
$queryType integer
$showUnfinished boolean
Returns
Type Description
arrayfalse
methodpublicgetTotalElapsedSecs( integer $queryType = null ) : float

Get the total elapsed time (in seconds) of all of the profiled queries.

Inherited from: \Zend_Db_Profiler::getTotalElapsedSecs()

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
methodpublicgetTotalNumQueries( 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.

Inherited from: \Zend_Db_Profiler::getTotalNumQueries()
Parameters
Name Type Description
$queryType integer OPTIONAL
Returns
Type Description
integer
methodpublicqueryClone(  $query ) : integer
Parameters
Name Type Description
$query
Returns
Type Description
integer or null
methodpublicqueryEnd( integer $queryId ) : void

Intercept the query end and log the profiling data.

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

Parameters
Name Type Description
$queryId integer
Throws
Exception Description
\Zend_Db_Profiler_Exception
methodpublicqueryStart( 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.

Inherited from: \Zend_Db_Profiler::queryStart()
Parameters
Name Type Description
$queryText string SQL statement
$queryType integer

OPTIONAL Type of query, one of the Zend_Db_Profiler::* constants

Returns
Type Description
integernull
methodpublicsetEnabled( 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
methodpublicsetFilterElapsedSecs( 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.

Inherited from: \Zend_Db_Profiler::setFilterElapsedSecs()
Parameters
Name Type Description
$minimumSeconds integer OPTIONAL
Returns
Type Description
\Zend_Db_Profiler Provides a fluent interface
methodpublicsetFilterQueryType( 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.

Inherited from: \Zend_Db_Profiler::setFilterQueryType()
Parameters
Name Type Description
$queryTypes integer OPTIONAL
Returns
Type Description
\Zend_Db_Profiler Provides a fluent interface
methodprotectedupdateMessageLabel( ) : void

Update the label of the message holding the profile info.

Documentation was generated by DocBlox 0.13.3.