PHP Класс Flarum\Core\Search\AbstractSearch

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$activeGambits Flarum\Core\Search\GambitInterface[]
$actor Flarum\Core\User
$defaultSort array
$query Illuminate\Database\Query\Builder

Открытые методы

Метод Описание
__construct ( Builder $query, User $actor )
addActiveGambit ( Flarum\Core\Search\GambitInterface $gambit ) : void Add a gambit as being active in this search.
getActiveGambits ( ) : Flarum\Core\Search\GambitInterface[] Get a list of the gambits that are active in this search.
getActor ( ) : User Get the user who is performing the search.
getDefaultSort ( ) : array Get the default sort order for the search.
getQuery ( ) : Builder Get the query builder for the search results query.
setDefaultSort ( array $defaultSort ) : mixed 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.

Описание методов

__construct() публичный Метод

public __construct ( Builder $query, User $actor )
$query Illuminate\Database\Query\Builder
$actor Flarum\Core\User

addActiveGambit() публичный Метод

Add a gambit as being active in this search.
public addActiveGambit ( Flarum\Core\Search\GambitInterface $gambit ) : void
$gambit Flarum\Core\Search\GambitInterface
Результат void

getActiveGambits() публичный Метод

Get a list of the gambits that are active in this search.
public getActiveGambits ( ) : Flarum\Core\Search\GambitInterface[]
Результат Flarum\Core\Search\GambitInterface[]

getActor() публичный Метод

Get the user who is performing the search.
public getActor ( ) : User
Результат Flarum\Core\User

getDefaultSort() публичный Метод

Get the default sort order for the search.
public getDefaultSort ( ) : array
Результат array

getQuery() публичный Метод

Get the query builder for the search results query.
public getQuery ( ) : Builder
Результат Illuminate\Database\Query\Builder

setDefaultSort() публичный Метод

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.
public setDefaultSort ( array $defaultSort ) : mixed
$defaultSort array 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.
Результат mixed

Описание свойств

$activeGambits защищенное свойство

protected GambitInterface[],Flarum\Core\Search $activeGambits
Результат Flarum\Core\Search\GambitInterface[]

$actor защищенное свойство

protected User,Flarum\Core $actor
Результат Flarum\Core\User

$defaultSort защищенное свойство

protected array $defaultSort
Результат array

$query защищенное свойство

protected Builder,Illuminate\Database\Query $query
Результат Illuminate\Database\Query\Builder