API Documentation
\
Phug
Ast
Compiler
Element
Event
Locator
NodeCompiler
Util
DependencyInjection
Event
Formatter
Element
Event
Format
Partial
Util
Lexer
Analyzer
Event
Partial
Scanner
Partial
Token
Parser
Event
Node
TokenHandler
Partial
Renderer
Adapter
Stream
Event
Partial
Debug
Profiler
Task
Test
Util
Exception
Partial

\Phug\Lexer\EventLexEvent

Summary

Methods
Properties
Constants
__construct()
getName()
getTarget()
getParams()
getParam()
setName()
setTarget()
setParams()
stopPropagation()
isPropagationStopped()
getInput()
setInput()
getPath()
setPath()
getStateClassName()
setStateClassName()
getStateOptions()
setStateOptions()
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
$stateClassName
$stateOptions
N/A

Properties

$name

$name :

Type

$target

$target :

Type

$params

$params :

Type

$propagationStopped

$propagationStopped :

Type

$input

$input :

Type

$path

$path :

Type

$stateClassName

$stateClassName :

Type

$stateOptions

$stateOptions :

Type

Methods

__construct()

__construct(string  $input, string|null  $path, string  $stateClassName, array  $stateOptions)

LexEvent constructor.

Parameters

string $input
string|null $path
string $stateClassName
array $stateOptions

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

getStateClassName()

getStateClassName() : string

Returns

string

setStateClassName()

setStateClassName(string  $stateClassName)

Parameters

string $stateClassName

getStateOptions()

getStateOptions() : array

Returns

array

setStateOptions()

setStateOptions(array  $stateOptions)

Parameters

array $stateOptions