Event emitted before action execution.
Methods¶
__construct()
¶
BeforeSuggestEvent.php
:
21
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $query | SuggestionQuery | - | - |
getQuery()
¶
BeforeSuggestEvent.php
:
31
|
|
|
Return values
SuggestionQuery
getSuggestionCollection()
¶
BeforeSuggestEvent.php
:
36
|
|
|
Return values
SuggestionCollection|null
isPropagationStopped()
¶
Event.php
:
38
|
|
|
Return values
bool
setQuery()
¶
BeforeSuggestEvent.php
:
26
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $query | SuggestionQuery | - | - |
setSuggestionCollection()
¶
BeforeSuggestEvent.php
:
41
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $suggestionCollection | SuggestionCollection | - | - |
stopPropagation()
¶
Event.php
:
50
Stops the propagation of the event to further event listeners.
|
|
|
If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().