PHP Класс Elastica\Query

Creates different types of queries
См. ссылку: http://www.elasticsearch.org/guide/reference/api/search/
Автор: Nicolas Ruflin ([email protected])
Наследование: extends Param
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$_suggest Suggest query or not.

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

Метод Описание
__construct ( array | Elastica\Query\AbstractQuery $query = null ) Creates a query object.
addAggregation ( AbstractAggregation $agg ) Adds an Aggregation to the query.
addHighlight ( mixed $highlight ) Adds a highlight argument.
addScriptField ( string $name, Elastica\Script\AbstractScript $script ) Adds a Script to the query.
addSort ( mixed $sort ) Adds a sort param to the query.
create ( mixed $query ) : self Transforms a string or an array to a query object.
getQuery ( ) : Elastica\Query\AbstractQuery Gets the query object.
setExplain ( boolean $explain = true ) Enables explain on the query.
setFieldDataFields ( array $fieldDataFields ) Sets the fields not stored to be returned by the search.
setFrom ( integer $from ) Sets the start from which the search results should be returned.
setHighlight ( array $highlightArgs ) Sets highlight arguments for the query.
setMinScore ( float $minScore ) Allows filtering of documents based on a minimum score.
setPostFilter ( Elastica\Query\AbstractQuery $filter ) Sets post_filter argument for the query. The filter is applied after the query has executed.
setQuery ( Elastica\Query\AbstractQuery $query ) Sets the query.
setRawQuery ( array $query ) Sets query as raw array. Will overwrite all already set arguments.
setRescore ( mixed $rescore ) Add a Rescore.
setScriptFields ( array | ScriptFields $scriptFields ) Set script fields.
setSize ( integer $size = 10 ) Sets maximum number of results for this query.
setSort ( array $sortArgs ) Sets sort arguments for the query Replaces existing values.
setSource ( array | boolean $params ) Sets the _source field to be returned with every hit.
setStoredFields ( array $fields ) Sets the fields to be returned by the search NOTICE php will encode modified(or named keys) array into object format in json format request so the fields array must a sequence(list) type of array.
setSuggest ( Suggest $suggest ) Add a suggest term.
setTrackScores ( boolean $trackScores = true ) Keep track of the scores when sorting results.
setVersion ( boolean $version = true ) Enables version on the query.
toArray ( ) : array Converts all query params to an array.

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

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

Creates a query object.
public __construct ( array | Elastica\Query\AbstractQuery $query = null )
$query array | Elastica\Query\AbstractQuery OPTIONAL Query object (default = null)

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

Adds an Aggregation to the query.
public addAggregation ( AbstractAggregation $agg )
$agg Elastica\Aggregation\AbstractAggregation

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

Adds a highlight argument.
См. ссылку: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-highlighting.html
public addHighlight ( mixed $highlight )
$highlight mixed Add highlight argument

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

Adds a Script to the query.
public addScriptField ( string $name, Elastica\Script\AbstractScript $script )
$name string
$script Elastica\Script\AbstractScript Script object

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

Adds a sort param to the query.
См. ссылку: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-sort.html
public addSort ( mixed $sort )
$sort mixed Sort parameter

create() публичный статический Метод

If query is empty,
public static create ( mixed $query ) : self
$query mixed
Результат self

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

Gets the query object.
public getQuery ( ) : Elastica\Query\AbstractQuery
Результат Elastica\Query\AbstractQuery

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

Enables explain on the query.
См. ссылку: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-explain.html
public setExplain ( boolean $explain = true )
$explain boolean OPTIONAL Enabled or disable explain (default = true)

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

Sets the fields not stored to be returned by the search.
См. ссылку: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-fielddata-fields.html
public setFieldDataFields ( array $fieldDataFields )
$fieldDataFields array Fields not stored to be returned

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

Sets the start from which the search results should be returned.
public setFrom ( integer $from )
$from integer

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

Sets highlight arguments for the query.
См. ссылку: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-highlighting.html
public setHighlight ( array $highlightArgs )
$highlightArgs array Set all highlight arguments

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

Allows filtering of documents based on a minimum score.
public setMinScore ( float $minScore )
$minScore float Minimum score to filter documents by

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

Sets post_filter argument for the query. The filter is applied after the query has executed.
См. ссылку: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-post-filter.html
public setPostFilter ( Elastica\Query\AbstractQuery $filter )
$filter Elastica\Query\AbstractQuery

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

Sets the query.
public setQuery ( Elastica\Query\AbstractQuery $query )
$query Elastica\Query\AbstractQuery Query object

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

Sets query as raw array. Will overwrite all already set arguments.
public setRawQuery ( array $query )
$query array Query array

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

Add a Rescore.
public setRescore ( mixed $rescore )
$rescore mixed suggestion object

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

Set script fields.
См. ссылку: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-script-fields.html
public setScriptFields ( array | ScriptFields $scriptFields )
$scriptFields array | Elastica\Script\ScriptFields Script fields

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

Sets maximum number of results for this query.
public setSize ( integer $size = 10 )
$size integer OPTIONAL Maximal number of results for query (default = 10)

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

Sets sort arguments for the query Replaces existing values.
См. ссылку: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-sort.html
public setSort ( array $sortArgs )
$sortArgs array Sorting arguments

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

Sets the _source field to be returned with every hit.
См. ссылку: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-source-filtering.html
public setSource ( array | boolean $params )
$params array | boolean Fields to be returned or false to disable source

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

Sets the fields to be returned by the search NOTICE php will encode modified(or named keys) array into object format in json format request so the fields array must a sequence(list) type of array.
См. ссылку: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-fields.html
public setStoredFields ( array $fields )
$fields array Fields to be returned

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

Add a suggest term.
public setSuggest ( Suggest $suggest )
$suggest Suggest suggestion object

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

Keep track of the scores when sorting results.
См. ссылку: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-sort.html#_track_scores
public setTrackScores ( boolean $trackScores = true )
$trackScores boolean

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

Enables version on the query.
См. ссылку: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-version.html
public setVersion ( boolean $version = true )
$version boolean OPTIONAL Enabled or disable version (default = true)

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

Converts all query params to an array.
public toArray ( ) : array
Результат array Query array

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

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

Suggest query or not.
protected $_suggest