Zend Framework API Documentation
Back to top  

Representation of an event

Encapsulates the target context and parameters passed, and provides some behavior for interacting with the event manager.

category Zend
package Zend_EventManager
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Constructor

__construct(string $name = null, string|object $target = null, array|\ArrayAccess $params = null) : void

Accept a target and its parameters.

Parameters

$name

string

Event name

$target

stringobject

$params

array\ArrayAccess

Get event name

getName() : string
inherited_from \Zend_EventManager_EventDescription::getName()

Returns

string

Get an individual parameter

getParam(string|integer $name, mixed $default = null) : mixed

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

inherited_from \Zend_EventManager_EventDescription::getParam()

Parameters

$name

stringinteger

$default

mixed

Returns

mixed

Get all parameters

getParams() : array | object | \ArrayAccess
inherited_from \Zend_EventManager_EventDescription::getParams()

Returns

arrayobject\ArrayAccess

Get the event target

getTarget() : string | object

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

inherited_from \Zend_EventManager_EventDescription::getTarget()

Returns

stringobject

Is propagation stopped?

propagationIsStopped() : boolean
inherited_from \Zend_EventManager_EventDescription::propagationIsStopped()

Returns

boolean

Set the event name

setName(string $name) : \Zend_EventManager_Event
inherited_from \Zend_EventManager_EventDescription::setName()

Parameters

$name

string

Returns

\Zend_EventManager_Event

Set an individual parameter to a value

setParam(string|integer $name, mixed $value) : \Zend_EventManager_Event
inherited_from \Zend_EventManager_EventDescription::setParam()

Parameters

$name

stringinteger

$value

mixed

Returns

\Zend_EventManager_Event

Set parameters

setParams(array|\ArrayAccess|object $params) : \Event

Overwrites parameters

inherited_from \Zend_EventManager_EventDescription::setParams()

Parameters

$params

array\ArrayAccessobject

Returns

\Event

Set the event target/context

setTarget(null|string|object $target) : \Zend_EventManager_Event
inherited_from \Zend_EventManager_EventDescription::setTarget()

Parameters

$target

nullstringobject

Returns

\Zend_EventManager_Event

Stop further event propagation

stopPropagation(boolean $flag = true) : void
inherited_from \Zend_EventManager_EventDescription::stopPropagation()

Parameters

$flag

boolean

 Properties

 

Event name

$name : string

Default

 

The event parameters

$params : array | \ArrayAccess | object

Default

array()
 

Whether or not to stop propagation

$stopPropagation : boolean

Default

false
 

The event target

$target : string | object

Default