Representation of an event

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

package Default

 Methods

Constructor

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

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\EventInterface::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\EventInterface::getParam()

Parameters

$name

stringinteger

$default

mixed

Returns

mixed

Get all parameters

getParams() : array | object | \ArrayAccess
inherited_from \Zend\EventManager\EventInterface::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\EventInterface::getTarget()

Returns

stringobject

Is propagation stopped?

propagationIsStopped() : boolean
inherited_from \Zend\EventManager\EventInterface::propagationIsStopped()

Returns

boolean

Set the event name

setName(string $name) : \Zend\EventManager\Event
inherited_from \Zend\EventManager\EventInterface::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\EventInterface::setParam()

Parameters

$name

stringinteger

$value

mixed

Returns

\Zend\EventManager\Event

Set parameters

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

Overwrites parameters

inherited_from \Zend\EventManager\EventInterface::setParams()

Parameters

$params

array\ArrayAccessobject

Exceptions

\Zend\EventManager\Exception\InvalidArgumentException

Returns

\Zend\EventManager\Event

Set the event target/context

setTarget(null|string|object $target) : \Zend\EventManager\Event
inherited_from \Zend\EventManager\EventInterface::setTarget()

Parameters

$target

nullstringobject

Returns

\Zend\EventManager\Event

Stop further event propagation

stopPropagation(boolean $flag = true) : void
inherited_from \Zend\EventManager\EventInterface::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