Classes:
Doctrine
Doctrine_Access
Doctrine_Adapter
Doctrine_Adapter_Db2_Exception
Doctrine_Adapter_Exception
Doctrine_Adapter_Statement
Doctrine_AuditLog
Doctrine_AuditLog_Listener
Doctrine_Collection
Doctrine_Collection_Exception
Doctrine_Collection_Iterator
Doctrine_Collection_Iterator_Expandable
Doctrine_Collection_Iterator_Normal
Doctrine_Collection_Iterator_Offset
Doctrine_Collection_Offset
Doctrine_Column
Doctrine_Compiler
Doctrine_Compiler_Exception
Doctrine_Configurable
Doctrine_Connection
Doctrine_Connection_Common
Doctrine_Connection_Db2
Doctrine_Connection_Exception
Doctrine_Connection_Firebird
Doctrine_Connection_Firebird_Exception
Doctrine_Connection_Informix
Doctrine_Connection_Informix_Exception
Doctrine_Connection_Mock
Doctrine_Connection_Module
Doctrine_Connection_Mssql
Doctrine_Connection_Mssql_Exception
Doctrine_Connection_Mysql
Doctrine_Connection_Mysql_Exception
Doctrine_Connection_Oracle
Doctrine_Connection_Oracle_Exception
Doctrine_Connection_Pgsql
Doctrine_Connection_Pgsql_Exception
Doctrine_Connection_Profiler
Doctrine_Connection_Profiler_Exception
Doctrine_Connection_Sqlite
Doctrine_Connection_Sqlite_Exception
Doctrine_Connection_Statement
Doctrine_Connection_UnitOfWork
Doctrine_DataDict
Doctrine_DataDict_Exception
Doctrine_DataDict_Informix
Doctrine_DataType
Doctrine_Db
Doctrine_Event
Doctrine_EventListener
Doctrine_EventListener_Chain
Doctrine_EventListener_Exception
Doctrine_Exception
Doctrine_Export
Doctrine_Export_Exception
Doctrine_Export_Firebird
Doctrine_Export_Frontbase
Doctrine_Export_Mssql
Doctrine_Export_Mysql
Doctrine_Export_Oracle
Doctrine_Export_Pgsql
Doctrine_Export_Reporter
Doctrine_Export_Schema
Doctrine_Export_Schema_Xml
Doctrine_Export_Schema_Yml
Doctrine_Export_Sqlite
Doctrine_Expression
Doctrine_Expression_Driver
Doctrine_Expression_Exception
Doctrine_Expression_Firebird
Doctrine_Expression_Informix
Doctrine_Expression_Mock
Doctrine_Expression_Mssql
Doctrine_Expression_Mysql
Doctrine_Expression_Oracle
Doctrine_Expression_Pgsql
Doctrine_Expression_Sqlite
Doctrine_File
Doctrine_File_Index
Doctrine_Formatter
Doctrine_Hook
Doctrine_Hook_Equal
Doctrine_Hook_Integer
Doctrine_Hook_Parser
Doctrine_Hook_Parser_Complex
Doctrine_Hook_WordLike
Doctrine_Hydrate
Doctrine_Hydrate_Array
Doctrine_Hydrate_Exception
Doctrine_Hydrate_Record
Doctrine_Import
Doctrine_Import_Builder
Doctrine_Import_Builder_BaseClass
Doctrine_Import_Builder_Exception
Doctrine_Import_Exception
Doctrine_Import_Firebird
Doctrine_Import_Informix
Doctrine_Import_Mssql
Doctrine_Import_Mysql
Doctrine_Import_Oracle
Doctrine_Import_Pgsql
Doctrine_Import_Reader
Doctrine_Import_Reader_Db
Doctrine_Import_Reader_Exception
Doctrine_Import_Reader_Xml_Propel
Doctrine_Import_Schema
Doctrine_Import_Schema_Xml
Doctrine_Import_Schema_Yml
Doctrine_Import_Sqlite
Doctrine_IntegrityMapper
Doctrine_Lib
Doctrine_Locking_Exception
Doctrine_Locking_Manager_Pessimistic
Doctrine_Manager
Doctrine_Manager_Exception
Doctrine_Node
Doctrine_Node_AdjacencyList
Doctrine_Node_AdjacencyList_LevelOrderIterator
Doctrine_Node_AdjacencyList_PostOrderIterator
Doctrine_Node_AdjacencyList_PreOrderIterator
Doctrine_Node_Exception
Doctrine_Node_MaterializedPath
Doctrine_Node_MaterializedPath_LevelOrderIterator
Doctrine_Node_MaterializedPath_PostOrderIterator
Doctrine_Node_MaterializedPath_PreOrderIterator
Doctrine_Node_NestedSet
Doctrine_Node_NestedSet_LevelOrderIterator
Doctrine_Node_NestedSet_PostOrderIterator
Doctrine_Node_NestedSet_PreOrderIterator
Doctrine_Null
Doctrine_Object
Doctrine_Plugin
Doctrine_Query
Doctrine_Query_Abstract
Doctrine_Query_Check
Doctrine_Query_Condition
Doctrine_Query_Exception
Doctrine_Query_Filter
Doctrine_Query_Filter_Chain
Doctrine_Query_From
Doctrine_Query_Groupby
Doctrine_Query_Having
Doctrine_Query_JoinCondition
Doctrine_Query_Limit
Doctrine_Query_Offset
Doctrine_Query_Orderby
Doctrine_Query_Parser
Doctrine_Query_Part
Doctrine_Query_Select
Doctrine_Query_Set
Doctrine_Query_Where
Doctrine_RawSql
Doctrine_RawSql_Exception
Doctrine_Record
Doctrine_Record_Abstract
Doctrine_Record_Exception
Doctrine_Record_Filter
Doctrine_Record_Iterator
Doctrine_Record_Listener
Doctrine_Record_Listener_Chain
Doctrine_Record_State_Exception
Doctrine_Relation
Doctrine_Relation_Association
Doctrine_Relation_Association_Self
Doctrine_Relation_Exception
Doctrine_Relation_ForeignKey
Doctrine_Relation_LocalKey
Doctrine_Relation_Nest
Doctrine_Relation_Parser
Doctrine_Relation_Parser_Exception
Doctrine_Schema
Doctrine_Schema_Column
Doctrine_Schema_Database
Doctrine_Schema_Exception
Doctrine_Schema_Object
Doctrine_Schema_Relation
Doctrine_Schema_Table
Doctrine_Search
Doctrine_Search_Analyzer
Doctrine_Search_Analyzer_Exception
Doctrine_Search_Analyzer_Standard
Doctrine_Search_Exception
Doctrine_Search_Indexer
Doctrine_Search_Indexer_Dir
Doctrine_Search_Indexer_Exception
Doctrine_Search_Listener
Doctrine_Search_Parser
Doctrine_Search_Query
Doctrine_Search_Record
Doctrine_Search_Scorer
Doctrine_Search_Template
Doctrine_Sequence
Doctrine_Sequence_Db2
Doctrine_Sequence_Exception
Doctrine_Sequence_Firebird
Doctrine_Sequence_Informix
Doctrine_Sequence_Mssql
Doctrine_Sequence_Mysql
Doctrine_Sequence_Oracle
Doctrine_Sequence_Pgsql
Doctrine_Sequence_Sqlite
Doctrine_Table
Doctrine_Table_Exception
Doctrine_Table_Repository
Doctrine_Table_Repository_Exception
Doctrine_Template
Doctrine_Template_NestedSet
Doctrine_Template_Searchable
Doctrine_Template_Taggable
Doctrine_Template_Versionable
Doctrine_Tokenizer
Doctrine_Transaction
Doctrine_Transaction_Exception
Doctrine_Transaction_Firebird
Doctrine_Transaction_Informix
Doctrine_Transaction_Mock
Doctrine_Transaction_Mssql
Doctrine_Transaction_Mysql
Doctrine_Transaction_Oracle
Doctrine_Transaction_Pgsql
Doctrine_Transaction_Sqlite
Doctrine_Tree
Doctrine_Tree_AdjacencyList
Doctrine_Tree_Exception
Doctrine_Tree_MaterializedPath
Doctrine_Tree_NestedSet
Doctrine_Util
Doctrine_Validator
Doctrine_Validator_Country
Doctrine_Validator_Creditcard
Doctrine_Validator_Date
Doctrine_Validator_Email
Doctrine_Validator_Enum
Doctrine_Validator_ErrorStack
Doctrine_Validator_Exception
Doctrine_Validator_HtmlColor
Doctrine_Validator_Ip
Doctrine_Validator_Minlength
Doctrine_Validator_Nospace
Doctrine_Validator_Notblank
Doctrine_Validator_Notnull
Doctrine_Validator_Range
Doctrine_Validator_Regexp
Doctrine_Validator_Unique
Doctrine_Validator_Unsigned
Doctrine_Validator_Usstate
Doctrine_View
Doctrine_View_Exception
Doctrine_Cache
Doctrine_Cache
Doctrine_Cache_Apc
Doctrine_Cache_Array
Doctrine_Cache_Db
Doctrine_Cache_Driver
Doctrine_Cache_Exception
Doctrine_Cache_Memcache
Doctrine_Adapter
Doctrine_Adapter_Db2
Doctrine_Adapter_Mock
Doctrine_Adapter_Mysqli
Doctrine_Adapter_Oracle
Doctrine_Adapter_Statement_Mock
Doctrine_DataDict
Doctrine_DataDict_Firebird
Doctrine_DataDict_Mssql
Doctrine_DataDict_Mysql
Doctrine_DataDict_Oracle
Doctrine_DataDict_Pgsql
Doctrine_DataDict_Sqlite

# Class: Doctrine_Event

Source Location: /Doctrine/Event.php

## Class Doctrine_Event

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 $_code $_endedMicrotime $_invoker $_options $_params $_query $_startedMicrotime | Methods __construct end getCode getElapsedSecs getInvoker getName getParams getQuery hasEnded skipOperation start __get __set

[ 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 ]