Zend Framework  1.12
Public Member Functions | Protected Attributes | List of all members
Zend_EventManager_Event Class Reference

Public Member Functions

 __construct ($name=null, $target=null, $params=null)
 Constructor.
 
 getName ()
 Get event name.
 
 getTarget ()
 Get the event target.
 
 setParams ($params)
 Set parameters.
 
 getParams ()
 Get all parameters.
 
 getParam ($name, $default=null)
 Get an individual parameter.
 
 setName ($name)
 Set the event name.
 
 setTarget ($target)
 Set the event target/context.
 
 setParam ($name, $value)
 Set an individual parameter to a value.
 
 stopPropagation ($flag=true)
 Stop further event propagation.
 
 propagationIsStopped ()
 Is propagation stopped?
 

Protected Attributes

 $name
 
 $target
 
 $params = array()
 
 $stopPropagation = false
 

Constructor & Destructor Documentation

__construct (   $name = null,
  $target = null,
  $params = null 
)

Constructor.

Accept a target and its parameters.

Parameters
string$nameEvent name
string | object$target
array | ArrayAccess$params
Returns
void

Member Function Documentation

getName ( )

Get event name.

Returns
string

Implements Zend_EventManager_EventDescription.

getParam (   $name,
  $default = null 
)

Get an individual parameter.

If the parameter does not exist, the $default value will be returned.

Parameters
string | int$name
mixed$default
Returns
mixed

Implements Zend_EventManager_EventDescription.

getParams ( )

Get all parameters.

Returns
array|object|ArrayAccess

Implements Zend_EventManager_EventDescription.

getTarget ( )

Get the event target.

This may be either an object, or the name of a static method.

Returns
string|object

Implements Zend_EventManager_EventDescription.

propagationIsStopped ( )

Is propagation stopped?

Returns
bool

Implements Zend_EventManager_EventDescription.

setName (   $name)

Set the event name.

Parameters
string$name
Returns
Zend_EventManager_Event

Implements Zend_EventManager_EventDescription.

setParam (   $name,
  $value 
)

Set an individual parameter to a value.

Parameters
string | int$name
mixed$value
Returns
Zend_EventManager_Event

Implements Zend_EventManager_EventDescription.

setParams (   $params)

Set parameters.

Overwrites parameters

Parameters
array | ArrayAccess | object$params
Returns
Event

Implements Zend_EventManager_EventDescription.

setTarget (   $target)

Set the event target/context.

Parameters
null | string | object$target
Returns
Zend_EventManager_Event

Implements Zend_EventManager_EventDescription.

stopPropagation (   $flag = true)

Stop further event propagation.

Parameters
bool$flag
Returns
void

Implements Zend_EventManager_EventDescription.

Member Data Documentation

$name
protected
$params = array()
protected
$stopPropagation = false
protected
$target
protected