PHP Класс Nqxcode\LuceneSearch\Query\Builder

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

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

Свойство Тип Описание
$limit integer
$offset integer
$query mixed Main query.
$queryBuilder Nqxcode\LuceneSearch\Query\RawQueryBuilder
$runner Nqxcode\LuceneSearch\Query\Runner

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

Метод Описание
__construct ( Nqxcode\LuceneSearch\Query\Runner $runner, Nqxcode\LuceneSearch\Query\RawQueryBuilder $queryBuilder, ZendSearch\Lucene\Search\Query\Boolean $query )
count ( ) : integer Execute the current query and return the total number of results.
get ( ) : Illuminate\Database\Eloquent\Collection Execute current query and return list of models.
limit ( integer $limit, integer $offset ) Limit results for query.
paginate ( integer $perPage = 25, integer | null $page = null ) : Illuminate\Pagination\Paginator Execute the current query and return a paginator for the results.
query ( $value, $field = '*', array $options = [] ) Add a basic search clause to the query.
rawQuery ( string | ZendSearch\Lucene\Search\Query\AbstractQuery $query ) Build raw query.
where ( string $field, mixed $value, array $options = [] ) Add where clause to the query for search by phrase.

Защищенные методы

Метод Описание
addSubquery ( ZendSearch\Lucene\Search\Query\Boolean $query, array $options ) : ZendSearch\Lucene\Search\Query\Boolean Add subquery to boolean query.

Приватные методы

Метод Описание
defaultOptions ( $options ) : array Get default values for options.

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

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

public __construct ( Nqxcode\LuceneSearch\Query\Runner $runner, Nqxcode\LuceneSearch\Query\RawQueryBuilder $queryBuilder, ZendSearch\Lucene\Search\Query\Boolean $query )
$runner Nqxcode\LuceneSearch\Query\Runner
$queryBuilder Nqxcode\LuceneSearch\Query\RawQueryBuilder
$query ZendSearch\Lucene\Search\Query\Boolean

addSubquery() защищенный Метод

Add subquery to boolean query.
protected addSubquery ( ZendSearch\Lucene\Search\Query\Boolean $query, array $options ) : ZendSearch\Lucene\Search\Query\Boolean
$query ZendSearch\Lucene\Search\Query\Boolean
$options array
Результат ZendSearch\Lucene\Search\Query\Boolean

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

Execute the current query and return the total number of results.
public count ( ) : integer
Результат integer

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

Execute current query and return list of models.
public get ( ) : Illuminate\Database\Eloquent\Collection
Результат Illuminate\Database\Eloquent\Collection

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

Limit results for query.
public limit ( integer $limit, integer $offset )
$limit integer
$offset integer

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

Execute the current query and return a paginator for the results.
public paginate ( integer $perPage = 25, integer | null $page = null ) : Illuminate\Pagination\Paginator
$perPage integer
$page integer | null
Результат Illuminate\Pagination\Paginator

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

Add a basic search clause to the query.
public query ( $value, $field = '*', array $options = [] )
$value
$field
$options array - required : should match (boolean, true by default) - prohibited : should not match (boolean, false by default) - phrase : phrase match (boolean, true by default) - proximity : value of distance between words (unsigned integer) - fuzzy : value of fuzzy(float, 0 ... 1)

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

Build raw query.
public rawQuery ( string | ZendSearch\Lucene\Search\Query\AbstractQuery $query )
$query string | ZendSearch\Lucene\Search\Query\AbstractQuery

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

Add where clause to the query for search by phrase.
public where ( string $field, mixed $value, array $options = [] )
$field string
$value mixed
$options array - field : field name - value : value to match - required : should match (boolean, true by default) - prohibited : should not match (boolean, false by default) - phrase : phrase match (boolean, true by default) - proximity : value of distance between words (unsigned integer) * - fuzzy : value of fuzzy(float, 0 ... 1)

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

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

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

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

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

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

Main query.
protected mixed $query
Результат mixed

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

protected RawQueryBuilder,Nqxcode\LuceneSearch\Query $queryBuilder
Результат Nqxcode\LuceneSearch\Query\RawQueryBuilder

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

protected Runner,Nqxcode\LuceneSearch\Query $runner
Результат Nqxcode\LuceneSearch\Query\Runner