PHP Класс ElasticSearcher\Abstracts\AbstractQuery

Наследование: use trait ElasticSearcher\Traits\BodyTrait
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$data array Data that can be used when building a query.
$fragmentParser ElasticSearcher\Parsers\FragmentParser
$indices array Indices on which the query should be executed.
$queryStringParams array Parameters to be added to the search URL.
$resultParser ElasticSearcher\Abstracts\AbstractResultParser
$searcher ElasticSearcher\ElasticSearcher
$types array Types on which the query should be executed.

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

Метод Описание
__construct ( ElasticSearcher $searcher )
addData ( array $data ) Add data that can be accessed during query building.
getData ( $key = null ) : mixed
getIndices ( ) : array Indices we are searching in.
getRawQuery ( ) : array Get the query after being build.
getResultParser ( ) : mixed
getTypes ( ) : array Types we are searching in.
parseResultsWith ( ElasticSearcher\Abstracts\AbstractResultParser $resultParser )
run ( ) : ElasticSearcher\Abstracts\AbstractResultParser Build and execute the query.
searchIn ( string | array $index, null | string | array $type = null ) Define on which indices and types the query should be run.

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

Метод Описание
buildQuery ( ) : array Build the query by adding all chunks together.
getQueryStringParam ( string $name ) : mixed
getSearchType ( ) : string
removeQueryStringParam ( string $name )
searchInIndices ( array $indices )
searchInTypes ( array $types )
setQueryStringParam ( string $name, mixed $value )
setSearchType ( string $type )
setup ( ) Prepare the query. Add filters, sorting, .

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

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

public __construct ( ElasticSearcher $searcher )
$searcher ElasticSearcher\ElasticSearcher

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

Add data that can be accessed during query building.
public addData ( array $data )
$data array

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

Build the query by adding all chunks together.
protected buildQuery ( ) : array
Результат array

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

public getData ( $key = null ) : mixed
Результат mixed

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

Indices we are searching in.
public getIndices ( ) : array
Результат array

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

protected getQueryStringParam ( string $name ) : mixed
$name string
Результат mixed

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

This is what will be sent to the elasticsearch SDK.
public getRawQuery ( ) : array
Результат array

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

public getResultParser ( ) : mixed
Результат mixed

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

protected getSearchType ( ) : string
Результат string

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

Types we are searching in.
public getTypes ( ) : array
Результат array

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

public parseResultsWith ( ElasticSearcher\Abstracts\AbstractResultParser $resultParser )
$resultParser ElasticSearcher\Abstracts\AbstractResultParser

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

protected removeQueryStringParam ( string $name )
$name string

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

Build and execute the query.
public run ( ) : ElasticSearcher\Abstracts\AbstractResultParser
Результат ElasticSearcher\Abstracts\AbstractResultParser

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

Define on which indices and types the query should be run.
public searchIn ( string | array $index, null | string | array $type = null )
$index string | array
$type null | string | array

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

protected searchInIndices ( array $indices )
$indices array

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

protected searchInTypes ( array $types )
$types array

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

protected setQueryStringParam ( string $name, mixed $value )
$name string
$value mixed

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

См. также: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-search-type.html
protected setSearchType ( string $type )
$type string

setup() абстрактный защищенный Метод

...
abstract protected setup ( )

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

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

Data that can be used when building a query.
protected array $data
Результат array

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

protected FragmentParser,ElasticSearcher\Parsers $fragmentParser
Результат ElasticSearcher\Parsers\FragmentParser

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

Indices on which the query should be executed.
protected array $indices
Результат array

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

Parameters to be added to the search URL.
protected array $queryStringParams
Результат array

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

protected AbstractResultParser,ElasticSearcher\Abstracts $resultParser
Результат ElasticSearcher\Abstracts\AbstractResultParser

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

protected ElasticSearcher,ElasticSearcher $searcher
Результат ElasticSearcher\ElasticSearcher

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

Types on which the query should be executed.
protected array $types
Результат array