AbstractQueryState  

abstract class AbstractQueryState

Properties

protected Builder $query
protected User $actor
protected mixed $defaultSort

Methods

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

No description

Builder
getQuery()

Get the query builder for the search results query.

User
getActor()

Get the user who is performing the search.

array
getDefaultSort()

Get the default sort order for the search.

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.

Details

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

Parameters

Builder $query
User $actor
$defaultSort

at line 48
Builder getQuery()

Get the query builder for the search results query.

Return Value

Builder

at line 58
User getActor()

Get the user who is performing the search.

Return Value

User

at line 68
array getDefaultSort()

Get the default sort order for the search.

Return Value

array

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