PHP Class Nqxcode\LuceneSearch\Query\Builder

Protected Properties

Property	Type	Description
$limit	integer
$offset	integer
$query	mixed	Main query.
$queryBuilder	Nqxcode\LuceneSearch\Query\RawQueryBuilder
$runner	Nqxcode\LuceneSearch\Query\Runner

Method	Description
__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.

Method	Description
addSubquery ( ZendSearch\Lucene\Search\Query\Boolean $query, array $options ) : ZendSearch\Lucene\Search\Query\Boolean	Add subquery to boolean query.

Method	Description
defaultOptions ( $options ) : array	Get default values for options.

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

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
return	ZendSearch\Lucene\Search\Query\Boolean

Execute the current query and return the total number of results.

public count ( ) : integer
return	integer

Execute current query and return list of models.

public get ( ) : Illuminate\Database\Eloquent\Collection
return	Illuminate\Database\Eloquent\Collection

Limit results for query.

public limit ( integer $limit, integer $offset )
$limit	integer
$offset	integer

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
return	Illuminate\Pagination\Paginator

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)

Build raw query.

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

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)

protected int $limit
return	integer

protected int $offset
return	integer

Main query.

protected mixed $query
return	mixed

protected RawQueryBuilder,Nqxcode\LuceneSearch\Query $queryBuilder
return	Nqxcode\LuceneSearch\Query\RawQueryBuilder

protected Runner,Nqxcode\LuceneSearch\Query $runner
return	Nqxcode\LuceneSearch\Query\Runner