Class Event

Summary

Fully Qualified Name: Zend\EventManager\Event
Implements: EventInterface

Description

Representation of an event

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

Methods

Name Description Defined By
__construct() Constructor Event
getName() Get event name Event
getParam() Get an individual parameter Event
getParams() Get all parameters Event
getTarget() Get the event target Event
propagationIsStopped() Is propagation stopped? Event
setName() Set the event name Event
setParam() Set an individual parameter to a value Event
setParams() Set parameters Event
setTarget() Set the event target/context Event
stopPropagation() Stop further event propagation Event

Method Details

__construct()

Constructor

Accept a target and its parameters.

Parameter Name Type Description
$name string Event
$target string|object
$params array|\ArrayAccess

Returns:

getName()

Get event name

Returns: string

getParam()

Get an individual parameter

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

Parameter Name Type Description
$name string|int
$default mixed

Returns: mixed

getParams()

Get all parameters

Returns: array|object|\ArrayAccess

getTarget()

Get the event target

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

Returns: string|object

propagationIsStopped()

Is propagation stopped?

Returns: bool

setName()

Set the event name

Parameter Name Type Description
$name string

Returns:

setParam()

Set an individual parameter to a value

Parameter Name Type Description
$name string|int
$value mixed

Returns:

setParams()

Set parameters

Overwrites parameters

Parameter Name Type Description
$params array|\ArrayAccess|object

Returns:

setTarget()

Set the event target/context

Parameter Name Type Description
$target null|string|object

Returns:

stopPropagation()

Stop further event propagation

Parameter Name Type Description
$flag bool

Returns:

Top