BeforeLiveSearchFormIsBuiltEvent
FinalYes
PSR-14 event to add, change or remove data for the live search form
Table of Contents
Methods
- __construct() : mixed
- addHint() : void
- addHints() : void
- getAdditionalViewData() : array<non-empty-string, mixed>
- getHints() : array<int, non-empty-string>
- getRequest() : ServerRequestInterface
- getSearchDemand() : SearchDemand
- setAdditionalViewData() : void
- setHints() : void
- setSearchDemand() : void
Methods
__construct()
public
__construct(array<int, non-empty-string> $hints, ServerRequestInterface $request) : mixed
Parameters
- $hints : array<int, non-empty-string>
- $request : ServerRequestInterface
addHint()
public
addHint(string $label) : void
Parameters
- $label : string
addHints()
public
addHints(string ...$labels) : void
Parameters
- $labels : string
getAdditionalViewData()
public
getAdditionalViewData() : array<non-empty-string, mixed>
Return values
array<non-empty-string, mixed>getHints()
public
getHints() : array<int, non-empty-string>
Return values
array<int, non-empty-string>getRequest()
public
getRequest() : ServerRequestInterface
Return values
ServerRequestInterfacegetSearchDemand()
public
getSearchDemand() : SearchDemand
Return values
SearchDemandsetAdditionalViewData()
public
setAdditionalViewData(array<non-empty-string, mixed> $viewData) : void
Parameters
- $viewData : array<non-empty-string, mixed>
setHints()
public
setHints(array<int, non-empty-string> $hints) : void
Parameters
- $hints : array<int, non-empty-string>
setSearchDemand()
public
setSearchDemand(SearchDemand $searchDemand) : void
Parameters
- $searchDemand : SearchDemand