SearchState  

class SearchState

Properties

protected FilterInterface[] $activeFilters

Methods

__construct(User $actor, bool $fulltextSearch, array|Closure $defaultSort = [])

No description

User
getActor()

No description

array|Closure
getDefaultSort()

No description

void
setDefaultSort(array|Closure $defaultSort)

<p>Set the default sort order for the search. This will only be applied if a sort order has not been specified in the search criteria.</p>

bool
isFulltextSearch()

No description

array
getActiveFilters()

<p>Get a list of the filters that are active.</p>

void
addActiveFilter(FilterInterface $filter)

No description

Details

at line 23
final __construct(User $actor, bool $fulltextSearch, array|Closure $defaultSort = [])

Parameters

User $actor
bool $fulltextSearch
array|Closure $defaultSort

at line 41
User getActor()

Return Value

User

at line 46
array|Closure getDefaultSort()

Return Value

array|Closure

at line 55
void setDefaultSort(array|Closure $defaultSort)

<p>Set the default sort order for the search. This will only be applied if a sort order has not been specified in the search criteria.</p>

Parameters

array|Closure $defaultSort

Return Value

void

at line 60
bool isFulltextSearch()

Return Value

bool

at line 70
array getActiveFilters()

<p>Get a list of the filters that are active.</p>

Return Value

array

at line 75
void addActiveFilter(FilterInterface $filter)

Parameters

FilterInterface $filter

Return Value

void