API Documentation

Db/Profiler/Query.php

Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Db
subpackage
Profiler
version
$Id: Query.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Db_Profiler_Query

Description

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.

Zend_Db_Profiler_Query

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Db
subpackage
Profiler
Properties
$_query
$_queryType
$_startedMicrotime
$_endedMicrotime
$_boundParams
Methods
__construct
__clone
start
end
hasEnded
getQuery
getQueryType
bindParam
bindParams
getQueryParams
getElapsedSecs

Description

Properties

$_boundParams

array $_boundParams = 'array'

Details

$_boundParams
array
visibility
protected
default
array
final
false
static
false

$_endedMicrotime

integer $_endedMicrotime = 'null'

Unix timestamp with microseconds when self::queryEnd() was called.

Details

$_endedMicrotime
integer
visibility
protected
default
null
final
false
static
false

$_query

string $_query = ''

SQL query string or user comment, set by $query argument in constructor.

Details

$_query
string
visibility
protected
default
final
false
static
false

$_queryType

integer $_queryType = '0'

One of the Zend_Db_Profiler constants for query type, set by $queryType argument in constructor.

Details

$_queryType
integer
visibility
protected
default
0
final
false
static
false

$_startedMicrotime

float $_startedMicrotime = 'null'

Unix timestamp with microseconds when instantiated.

Details

$_startedMicrotime
float
visibility
protected
default
null
final
false
static
false

Methods

__clone

__clone( ) : void

Clone handler for the query object.

Details
visibility
public
final
false
static
false

__construct

__construct( string $query, integer $queryType ) : void

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

Arguments
$query
string
$queryType
integer
Details
visibility
public
final
false
static
false

bindParam

bindParam( string $param, mixed $variable ) : void

Arguments
$param
string
$variable
mixed
Details
visibility
public
final
false
static
false

bindParams

bindParams(  $params ) : void

Arguments
$params
Details
visibility
public
final
false
static
false

end

end( ) : void

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

Details
visibility
public
final
false
static
false

getElapsedSecs

getElapsedSecs( ) : float|false

Get the elapsed time (in seconds) that the query ran.

If the query has not yet ended, false is returned.

Output
float|false
Details
visibility
public
final
false
static
false

getQuery

getQuery( ) : string

Get the original SQL text of the query.

Output
string
Details
visibility
public
final
false
static
false

getQueryParams

getQueryParams( ) : array

Output
array
Details
visibility
public
final
false
static
false

getQueryType

getQueryType( ) : integer

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

Output
integer
Details
visibility
public
final
false
static
false

hasEnded

hasEnded( ) : boolean

Returns true if and only if the query has ended.

Output
boolean
Details
visibility
public
final
false
static
false

start

start( ) : void

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.

Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.