\Phug\Compiler\EventCompileEvent

Summary

Methods
Properties
Constants
__construct()
getName()
getTarget()
getParams()
getParam()
setName()
setTarget()
setParams()
stopPropagation()
isPropagationStopped()
getInput()
setInput()
getPath()
setPath()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$name
$target
$params
$propagationStopped
$input
$path
N/A

Properties

$name

$name : 

Type

$target

$target : 

Type

$params

$params : 

Type

$propagationStopped

$propagationStopped : 

Type

$input

$input : 

Type

$path

$path : 

Type

Methods

__construct()

__construct(string  $input, string|null  $path = null) 

CompileEvent constructor.

Parameters

string $input
string|null $path

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

getInput()

getInput() : string

Returns

string

setInput()

setInput(string  $input) 

Parameters

string $input

getPath()

getPath() : string|null

Returns

string|null

setPath()

setPath(string|null  $path = null) 

Parameters

string|null $path