Copied!

BeforeSuggestEvent

BeforeSuggestEvent.php : 15
Extends BeforeEvent

Event emitted before action execution.

Methods

public__construct()

BeforeSuggestEvent.php : 21
public __construct(SuggestionQuery $query)

Parameters

Name Type Default value Description
$query SuggestionQuery - -

publicgetQuery()

BeforeSuggestEvent.php : 31
public getQuery() : SuggestionQuery

Return values

SuggestionQuery

publicgetSuggestionCollection()

BeforeSuggestEvent.php : 36
public getSuggestionCollection() : SuggestionCollection|null

Return values

SuggestionCollection|null

publicisPropagationStopped()

Event.php : 38
public isPropagationStopped() : bool

Return values

bool

publicsetQuery()

BeforeSuggestEvent.php : 26
public setQuery(SuggestionQuery $query) : void

Parameters

Name Type Default value Description
$query SuggestionQuery - -

publicsetSuggestionCollection()

BeforeSuggestEvent.php : 41
public setSuggestionCollection(SuggestionCollection $suggestionCollection) : void

Parameters

Name Type Default value Description
$suggestionCollection SuggestionCollection - -

publicstopPropagation()

Event.php : 50

Stops the propagation of the event to further event listeners.

public stopPropagation() : void

If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().