EventInterface Interface Reference

Representation of an event. More...

Public Member Functions
	getName ()
	Get event name.
	getTarget ()
	Get target/context from which event was triggered.
	getParams ()
	Get parameters passed to the event.
	getParam ($name, $default=null)
	Get a single parameter by name.
	setName ($name)
	Set the event name.
	setTarget ($target)
	Set the event target/context.
	setParams ($params)
	Set event parameters.
	setParam ($name, $value)
	Set a single parameter by key.
	stopPropagation ($flag=true)
	Indicate whether or not the parent EventManagerInterface should stop propagating events.
	propagationIsStopped ()
	Has this event indicated event propagation should stop?

Detailed Description

Representation of an event.

Member Function Documentation

getName

(

)

Get event name.

Returns

string

Implemented in Event, and TableGatewayEvent.

getParam	(		$name,
			$default = null
	)

Get a single parameter by name.

Parameters

string	$name
mixed	$default	Default value to return if parameter does not exist

Returns

mixed

Implemented in ViewEvent, Event, and TableGatewayEvent.

getParams

(

)

Get parameters passed to the event.

Returns

array|ArrayAccess

Implemented in ViewEvent, Event, and TableGatewayEvent.

getTarget

(

)

Get target/context from which event was triggered.

Returns

null|string|object

Implemented in Event, and TableGatewayEvent.

propagationIsStopped

(

)

Has this event indicated event propagation should stop?

Returns

bool

Implemented in Event, and TableGatewayEvent.

setName

(

$name

)

Set the event name.

Parameters

string

$name

Returns

void

Implemented in Event, and TableGatewayEvent.

setParam	(		$name,
			$value
	)

Set a single parameter by key.

Parameters

string	$name
mixed	$value

Returns

void

Implemented in ViewEvent, Event, and TableGatewayEvent.

setParams

(

$params

)

Set event parameters.

Parameters

array | ArrayAccess

$params

Returns

void

Implemented in ViewEvent, TableGatewayEvent, and Event.

setTarget

(

$target

)

Set the event target/context.

Parameters

null | string | object

$target

Returns

void

Implemented in Event, TableGatewayEvent, and Event.

stopPropagation

(

$flag = true

)

Indicate whether or not the parent EventManagerInterface should stop propagating events.

Parameters

bool

$flag

Returns

void

Implemented in Event, and TableGatewayEvent.