Class Overview

Doctrine_Event

Located in /Doctrine/Event.php [line 32]

Author(s):

Konsta Vesterinen <kvesteri@cc.hut.fi>

Information Tags:

Version:	$Revision$
Link:	www.phpdoctrine.com
Since:	1.0
License:	LGPL

Properties

Methods

[ Top ]

Constant Summary

CONN_CLOSE
CONN_CONNECT
CONN_ERROR
CONN_EXEC
CONN_PREPARE
CONN_QUERY	CONNECTION EVENT CODES
RECORD_DELETE
RECORD_INSERT
RECORD_SAVE
RECORD_SERIALIZE
RECORD_UNSERIALIZE
RECORD_UPDATE
SAVEPOINT_COMMIT
SAVEPOINT_CREATE
SAVEPOINT_ROLLBACK
STMT_EXECUTE
STMT_FETCH
STMT_FETCHALL
TX_BEGIN
TX_COMMIT
TX_ROLLBACK

[ Top ]

Property Summary

integer	$_code
integer	$_endedMicrotime
mixed	$_invoker
array	$_options
string	$_params
string	$_query
integer	$_startedMicrotime

[ Top ]

Method Summary

Doctrine_Event	__construct()	constructor
Doctrine_Event	end()	end ends the internal timer of this event
integer	getCode()	getCode
mixed	getElapsedSecs()	Get the elapsed time (in microseconds) that the event ran. If the event has not yet ended, return false.
Doctrine_Connection\|Doctrine_Connection_Statement\|	getInvoker()	getInvoker returns the handler that invoked this event
string	getName()	getName returns the name of this event
array	getParams()	getParams returns the parameters of the query
string	getQuery()	getQuery
boolean	hasEnded()	hasEnded whether or not this event has ended
Doctrine_Event	skipOperation()	skipOperation skips the next operation an alias for __set('skipOperation', true)
Doctrine_Event	start()	start starts the internal timer of this event
mixed	__get()	getOption returns the value of an option
Doctrine_Event	__set()	setOption sets the value of an option

[ Top ]

Properties

integer $_code [line 80]

API Tags:

See:	Doctrine_Event constants
Access:	protected

[ Top ]

integer $_endedMicrotime [line 88]

API Tags:

Access:

protected

[ Top ]

mixed $_invoker [line 67]

API Tags:

Access:

protected

[ Top ]

array $_options = array() [line 92]

API Tags:

Access:

protected

[ Top ]

string $_params [line 75]

API Tags:

Access:

protected

[ Top ]

string $_query [line 71]

API Tags:

Access:

protected

[ Top ]

integer $_startedMicrotime [line 84]

API Tags:

Access:

protected

[ Top ]

Methods

Constructor __construct [line 101]

Doctrine_Event __construct(
Doctrine_Connection|Doctrine_Connection_Statement|
$invoker, integer
$code, [string
$query = null], [
$params = array()] 
)

constructor

Parameters:

integer	$code:	the event code
string	$query:	the sql query associated with this event (if any)
Doctrine_Connection\|Doctrine_Connection_Statement\|	$invoker:
	$params:

API Tags:

Access:

public

[ Top ]

end [line 251]

Doctrine_Event end(
)

end ends the internal timer of this event

API Tags:

Return:	this object
Access:	public

[ Top ]

getCode [line 179]

integer getCode(
)

getCode

API Tags:

Return:	returns the code associated with this event
Access:	public

[ Top ]

getElapsedSecs [line 284]

mixed getElapsedSecs(
)

Get the elapsed time (in microseconds) that the event ran. If the event has not yet ended, return false.

API Tags:

Access:

public

[ Top ]

getInvoker [line 264]

Doctrine_Connection|Doctrine_Connection_Statement| getInvoker(
)

getInvoker returns the handler that invoked this event

API Tags:

Return:	Doctrine_Connection_UnitOfWork\|Doctrine_Transaction the handler that invoked this event
Access:	public

[ Top ]

getName [line 123]

string getName(
)

getName returns the name of this event

API Tags:

Return:	the name of this event
Access:	public

[ Top ]

getParams [line 274]

array getParams(
)

getParams returns the parameters of the query

API Tags:

Return:	parameters of the query
Access:	public

[ Top ]

getQuery [line 113]

string getQuery(
)

getQuery

API Tags:

Return:	returns the query associated with this event (if any)
Access:	public

[ Top ]

hasEnded [line 241]

boolean hasEnded(
)

hasEnded whether or not this event has ended

API Tags:

Access:

public

[ Top ]

skipOperation [line 205]

Doctrine_Event skipOperation(
)

skipOperation skips the next operation an alias for __set('skipOperation', true)

API Tags:

Return:	this object
Access:	public

[ Top ]

start [line 231]

Doctrine_Event start(
)

start starts the internal timer of this event

API Tags:

Return:	this object
Access:	public

[ Top ]

__get [line 190]

mixed __get(
string
$option 
)

getOption returns the value of an option

Parameters:

string

$option:

the name of the option

API Tags:

Access:

public

[ Top ]

__set [line 219]

Doctrine_Event __set(
string
$option, mixed
$value 
)

setOption sets the value of an option

Parameters:

string	$option:	the name of the option
mixed	$value:	the value of the given option

API Tags:

Return:	this object
Access:	public

[ Top ]

Constants

CONN_CLOSE = 5 [line 41]

[ Top ]

CONN_CONNECT = 4 [line 40]

[ Top ]

CONN_ERROR = 6 [line 42]

[ Top ]

CONN_EXEC = 2 [line 38]

[ Top ]

CONN_PREPARE = 3 [line 39]

[ Top ]

CONN_QUERY = 1 [line 37]

CONNECTION EVENT CODES

[ Top ]

RECORD_DELETE = 21 [line 58]

[ Top ]

RECORD_INSERT = 24 [line 61]

[ Top ]

RECORD_SAVE = 22 [line 59]

[ Top ]

RECORD_SERIALIZE = 25 [line 62]

[ Top ]

RECORD_UNSERIALIZE = 26 [line 63]

[ Top ]

RECORD_UPDATE = 23 [line 60]

[ Top ]

SAVEPOINT_COMMIT = 36 [line 53]

[ Top ]

SAVEPOINT_CREATE = 34 [line 51]

[ Top ]

SAVEPOINT_ROLLBACK = 35 [line 52]

[ Top ]

STMT_EXECUTE = 10 [line 44]

[ Top ]

STMT_FETCH = 11 [line 45]

[ Top ]

STMT_FETCHALL = 12 [line 46]

[ Top ]

TX_BEGIN = 31 [line 48]

[ Top ]

TX_COMMIT = 32 [line 49]

[ Top ]

TX_ROLLBACK = 33 [line 50]

[ Top ]

Class: Doctrine_Event

Class Doctrine_Event