WebVIEP Plugin

BoothSearchCriteria
in package

FinalYes

Value object encapsulating booth search parameters.

Table of Contents

Properties

$page  : int
$perPage  : int
$query  : string|null
$scope  : string
$topics  : array<string|int, string>

Methods

__construct()  : mixed
BoothSearchCriteria constructor.
page()  : int
Current page (1-based).
perPage()  : int
Items per page.
query()  : string|null
Free-text query.
scope()  : string
Search scope (booths/items/both).
topics()  : array<string|int, string>
Topic slugs to filter by.

Properties

Methods

__construct()

BoothSearchCriteria constructor.

public __construct([string|null $query = null ][, array<string|int, string> $topics = [] ][, int $page = 1 ][, int $perPage = 12 ][, string $scope = SearchScope::BOOTHS_ONLY ]) : mixed
Parameters
$query : string|null = null
$topics : array<string|int, string> = []
$page : int = 1
$perPage : int = 12
$scope : string = SearchScope::BOOTHS_ONLY

SearchScope::*

scope()

Search scope (booths/items/both).

public scope() : string
Return values
string

topics()

Topic slugs to filter by.

public topics() : array<string|int, string>
Return values
array<string|int, string>

        
On this page

Search results