Zend Framework  1.12
Public Member Functions | List of all members
Zend_EventManager_EventDescription Interface Reference

Public Member Functions

 getName ()
 Get event name.
 
 getTarget ()
 Get target/context from which event was triggered.
 
 getParams ()
 Get parameters passed to the event.
 
 getParam ($name, $default=null)
 Get a single parameter by name.
 
 setName ($name)
 Set the event name.
 
 setTarget ($target)
 Set the event target/context.
 
 setParams ($params)
 Set event parameters.
 
 setParam ($name, $value)
 Set a single parameter by key.
 
 stopPropagation ($flag=true)
 Indicate whether or not the parent EventCollection should stop propagating events.
 
 propagationIsStopped ()
 Has this event indicated event propagation should stop?
 

Member Function Documentation

getName ( )

Get event name.

Returns
string

Implemented in Zend_EventManager_Event.

getParam (   $name,
  $default = null 
)

Get a single parameter by name.

Parameters
string$name
mixed$defaultDefault value to return if parameter does not exist
Returns
mixed

Implemented in Zend_EventManager_Event.

getParams ( )

Get parameters passed to the event.

Returns
array|ArrayAccess

Implemented in Zend_EventManager_Event.

getTarget ( )

Get target/context from which event was triggered.

Returns
null|string|object

Implemented in Zend_EventManager_Event.

propagationIsStopped ( )

Has this event indicated event propagation should stop?

Returns
bool

Implemented in Zend_EventManager_Event.

setName (   $name)

Set the event name.

Parameters
string$name
Returns
void

Implemented in Zend_EventManager_Event.

setParam (   $name,
  $value 
)

Set a single parameter by key.

Parameters
string$name
mixed$value
Returns
void

Implemented in Zend_EventManager_Event.

setParams (   $params)

Set event parameters.

Parameters
string$params
Returns
void

Implemented in Zend_EventManager_Event.

setTarget (   $target)

Set the event target/context.

Parameters
null | string | object$target
Returns
void

Implemented in Zend_EventManager_Event.

stopPropagation (   $flag = true)

Indicate whether or not the parent EventCollection should stop propagating events.

Parameters
bool$flag
Returns
void

Implemented in Zend_EventManager_Event.