\PhugEventInterface

Representation of an event.

Summary

Methods
Constants
getName()
getTarget()
getParams()
getParam()
setName()
setTarget()
setParams()
stopPropagation()
isPropagationStopped()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

getName()

getName() : string

Get event name.

Returns

string

getTarget()

getTarget() : null|string|object

Get target/context from which event was triggered.

Returns

null|string|object

getParams()

getParams() : array

Get parameters passed to the event.

Returns

array

getParam()

getParam(string  $name) : mixed

Get a single parameter by name.

Parameters

string $name

Returns

mixed

setName()

setName(string  $name) : void

Set the event name.

Parameters

string $name

setTarget()

setTarget(null|string|object  $target) : void

Set the event target.

Parameters

null|string|object $target

setParams()

setParams(array  $params) : void

Set event parameters.

Parameters

array $params

stopPropagation()

stopPropagation(boolean  $flag) 

Indicate whether or not to stop propagating this event.

Parameters

boolean $flag

isPropagationStopped()

isPropagationStopped() : boolean

Has this event indicated event propagation should stop?

Returns

boolean