PHP Класс Elastica\Search

Автор: Nicolas Ruflin ([email protected])
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$_client Client Client object.
$_indices array Array of indices.
$_options array
$_query Query
$_types array Array of types.

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

Метод Описание
__construct ( Client $client, Elastica\ResultSet\BuilderInterface $builder = null ) Constructs search object.
addIndex ( Index | string $index ) Adds a index to the list.
addIndices ( array $indices = [] ) Add array of indices at once.
addOption ( string $key, mixed $value )
addType ( Type | string $type ) Adds a type to the current search.
addTypes ( array $types = [] ) Add array of types.
clearOptions ( )
count ( mixed $query = '', $fullResult = false ) : integer | ResultSet
create ( elastica\SearchableInterface $searchObject ) : Search Creates new search object.
getClient ( ) : Client Return client object.
getIndices ( ) : array Return array of indices.
getOption ( string $key ) : mixed
getOptions ( ) : array
getPath ( ) : string Combines indices and types to the search request path.
getQuery ( ) : Query
getResultSetBuilder ( ) : Elastica\ResultSet\BuilderInterface
getTypes ( ) : array Return array of types.
hasIndex ( Index | string $index ) : boolean
hasIndices ( ) : boolean
hasOption ( string $key ) : boolean
hasType ( Type | string $type ) : boolean
hasTypes ( ) : boolean
scroll ( string $expiryTime = '1m' ) : Scroll Returns the Scroll Iterator.
search ( mixed $query = '', integer | array $options = null ) : ResultSet Search in the set indices, types.
setOption ( string $key, mixed $value )
setOptions ( array $options )
setOptionsAndQuery ( array | integer $options = null, string | array | Query $query = '' )
setQuery ( string | array | Query | Elastica\Suggest | Elastica\Query\AbstractQuery $query )
setSuggest ( elastica\Suggest $suggest )

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

Метод Описание
_validateOption ( string $key ) : boolean

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

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

Constructs search object.
public __construct ( Client $client, Elastica\ResultSet\BuilderInterface $builder = null )
$client Client Client object
$builder Elastica\ResultSet\BuilderInterface

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

protected _validateOption ( string $key ) : boolean
$key string
Результат boolean

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

Adds a index to the list.
public addIndex ( Index | string $index )
$index Index | string Index object or string

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

Add array of indices at once.
public addIndices ( array $indices = [] )
$indices array

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

public addOption ( string $key, mixed $value )
$key string
$value mixed

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

Adds a type to the current search.
public addType ( Type | string $type )
$type Type | string Type name or object

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

Add array of types.
public addTypes ( array $types = [] )
$types array

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

public clearOptions ( )

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

public count ( mixed $query = '', $fullResult = false ) : integer | ResultSet
$query mixed
$fullResult (default = false) By default only the total hit count is returned. If set to true, the full ResultSet including aggregations is returned
Результат integer | ResultSet

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

Creates new search object.
public static create ( elastica\SearchableInterface $searchObject ) : Search
$searchObject elastica\SearchableInterface
Результат Search

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

Return client object.
public getClient ( ) : Client
Результат Client Client object

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

Return array of indices.
public getIndices ( ) : array
Результат array List of index names

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

public getOption ( string $key ) : mixed
$key string
Результат mixed

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

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

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

Combines indices and types to the search request path.
public getPath ( ) : string
Результат string Search path

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

public getQuery ( ) : Query
Результат Query

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

public getResultSetBuilder ( ) : Elastica\ResultSet\BuilderInterface
Результат Elastica\ResultSet\BuilderInterface

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

Return array of types.
public getTypes ( ) : array
Результат array List of types

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

public hasIndex ( Index | string $index ) : boolean
$index Index | string
Результат boolean

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

public hasIndices ( ) : boolean
Результат boolean

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

public hasOption ( string $key ) : boolean
$key string
Результат boolean

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

public hasType ( Type | string $type ) : boolean
$type Type | string
Результат boolean

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

public hasTypes ( ) : boolean
Результат boolean

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

Returns the Scroll Iterator.
См. также: Elastica\Scroll
public scroll ( string $expiryTime = '1m' ) : Scroll
$expiryTime string
Результат Scroll

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

public setOption ( string $key, mixed $value )
$key string
$value mixed

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

public setOptions ( array $options )
$options array

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

public setOptionsAndQuery ( array | integer $options = null, string | array | Query $query = '' )
$options array | integer
$query string | array | Query

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

public setQuery ( string | array | Query | Elastica\Suggest | Elastica\Query\AbstractQuery $query )
$query string | array | Query | Elastica\Suggest | Elastica\Query\AbstractQuery

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

public setSuggest ( elastica\Suggest $suggest )
$suggest elastica\Suggest

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

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

Client object.
protected Client,Elastica $_client
Результат Client

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

Array of indices.
protected array $_indices
Результат array

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

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

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

protected Query,Elastica $_query
Результат Query

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

Array of types.
protected array $_types
Результат array