Interface EventInterface

Summary

Fully Qualified Name: Zend\EventManager\EventInterface

Description

Representation of an event

Methods

Name Description Defined By
getName() Get event name EventInterface
getParam() Get a single parameter by name EventInterface
getParams() Get parameters passed to the event EventInterface
getTarget() Get target/context from which event was triggered EventInterface
propagationIsStopped() Has this event indicated event propagation should stop? EventInterface
setName() Set the event name EventInterface
setParam() Set a single parameter by key EventInterface
setParams() Set event parameters EventInterface
setTarget() Set the event target/context EventInterface
stopPropagation() Indicate whether or not the parent EventManagerInterface should stop propagating events EventInterface

Method Details

getName()

Get event name

Returns: string

getParam()

Get a single parameter by name

Parameter Name Type Description
$name string
$default mixed Default

Returns: mixed

getParams()

Get parameters passed to the event

Returns: array|\ArrayAccess

getTarget()

Get target/context from which event was triggered

Returns: null|string|object

propagationIsStopped()

Has this event indicated event propagation should stop?

Returns: bool

setName()

Set the event name

Parameter Name Type Description
$name string

Returns: void

setParam()

Set a single parameter by key

Parameter Name Type Description
$name string
$value mixed

Returns: void

setParams()

Set event parameters

Parameter Name Type Description
$params array|\ArrayAccess

Returns: void

setTarget()

Set the event target/context

Parameter Name Type Description
$target null|string|object

Returns: void

stopPropagation()

Indicate whether or not the parent EventManagerInterface should stop propagating events

Parameter Name Type Description
$flag bool

Returns: void

Top