SearchState  

class SearchState extends AbstractQueryState

Properties

protected Builder $query from AbstractQueryState
protected User $actor from AbstractQueryState
protected mixed $defaultSort from AbstractQueryState
protected GambitInterface[] $activeGambits

Methods

__construct(Builder $query, User $actor, $defaultSort = [])

No description

from AbstractQueryState
Builder
getQuery()

Get the query builder for the search results query.

from AbstractQueryState
User
getActor()

Get the user who is performing the search.

from AbstractQueryState
array
getDefaultSort()

Get the default sort order for the search.

from AbstractQueryState
mixed
setDefaultSort(mixed $defaultSort)

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.

from AbstractQueryState
GambitInterface[]
getActiveGambits()

Get a list of the gambits that are active in this search.

void
addActiveGambit(GambitInterface $gambit)

Add a gambit as being active in this search.

Details

in AbstractQueryState at line 36
__construct(Builder $query, User $actor, $defaultSort = [])

Parameters

Builder $query
User $actor
$defaultSort

in AbstractQueryState at line 48
Builder getQuery()

Get the query builder for the search results query.

Return Value

Builder

in AbstractQueryState at line 58
User getActor()

Get the user who is performing the search.

Return Value

User

in AbstractQueryState at line 68
array getDefaultSort()

Get the default sort order for the search.

Return Value

array

in AbstractQueryState at line 83
mixed setDefaultSort(mixed $defaultSort)

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.

Parameters

mixed $defaultSort An array of sort-order pairs, where the column is the key, and the order is the value. The order may be 'asc', 'desc', or an array of IDs to order by. Alternatively, a callable may be used.

Return Value

mixed

at line 26
GambitInterface[] getActiveGambits()

Get a list of the gambits that are active in this search.

Return Value

GambitInterface[]

at line 37
void addActiveGambit(GambitInterface $gambit)

Add a gambit as being active in this search.

Parameters

GambitInterface $gambit

Return Value

void