PHP Класс Spatie\SearchIndex\Query\Algolia\SearchQuery

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

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

Свойство	Тип	Описание
$aroundRadius	integer
$dateRestrictions	array
$facets	array
$hitsPerPage	integer
$lat	integer
$lng	integer
$numericFilters	array
$page	integer
$query
$useLocationAwareSearch	boolean

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

Метод	Описание
aroundLocation ( integer $lat, integer $lng, integer $aroundRadius = 30000 )	Create a location aware search.
searchFor ( mixed $query ) : SearchQuery	Set the query to search for.
setHitsPerPage ( integer $hitsPerPage ) : SearchQuery
setPage ( integer $page ) : SearchQuery
toArray ( ) : array	Get the query as an array.
withDateRestriction ( string $dateFieldName, string $operation, DateTime $date )	Set a date restriction.
withFacet ( string $name, string $value )	Set a facet.
withNumericFilter ( string $name, string \| array $values, string $logicalOperator = 'and' )	Set a numeric filter.

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

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

Create a location aware search.

public aroundLocation ( integer $lat, integer $lng, integer $aroundRadius = 30000 )
$lat	integer
$lng	integer
$aroundRadius	integer

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

Set the query to search for.

public searchFor ( mixed $query ) : SearchQuery
$query	mixed
Результат	SearchQuery

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

public setHitsPerPage ( integer $hitsPerPage ) : SearchQuery
$hitsPerPage	integer
Результат	SearchQuery

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

public setPage ( integer $page ) : SearchQuery
$page	integer
Результат	SearchQuery

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

Get the query as an array.

public toArray ( ) : array
Результат	array

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

Set a date restriction.

public withDateRestriction ( string $dateFieldName, string $operation, DateTime $date )
$dateFieldName	string
$operation	string
$date	DateTime

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

Set a facet.

public withFacet ( string $name, string $value )
$name	string
$value	string

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

Set a numeric filter.

public withNumericFilter ( string $name, string \| array $values, string $logicalOperator = 'and' )
$name	string
$values	string \| array
$logicalOperator	string

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

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

protected int $aroundRadius
Результат	integer

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

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

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

protected int $hitsPerPage
Результат	integer

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

protected int $lat
Результат	integer

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

protected int $lng
Результат	integer

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

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

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

protected int $page
Результат	integer

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

protected $query

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

protected bool $useLocationAwareSearch
Результат	boolean