PHP Class Elastica\Multi\Search

See link: http://www.elasticsearch.org/guide/reference/api/multi-search.html

Author: munkie

Show file Open project: ruflin/Elastica Class Usage Examples

Protected Properties

Property	Type	Description
$_client	Elastica\Client
$_options	array
$_searches	array \| Elastica\Search[]

Public Methods

Method	Description
__construct ( Client $client, Elastica\Multi\MultiBuilderInterface $builder = null )	Constructs search object.
addSearch ( Search $search, string $key = null )
addSearches ( array $searches )
clearSearches ( )
getClient ( ) : Client
getSearches ( ) : array \| Search[]
search ( ) : ResultSet
setSearchType ( string $searchType )
setSearches ( array $searches )

Protected Methods

Method	Description
_getData ( ) : string
_getSearchData ( Search $search ) : string
_getSearchDataHeader ( Search $search ) : array

Method Details

__construct() public method

Constructs search object.

public __construct ( Client $client, Elastica\Multi\MultiBuilderInterface $builder = null )
$client	Elastica\Client	Client object
$builder	Elastica\Multi\MultiBuilderInterface

_getData() protected method

protected _getData ( ) : string
return	string

_getSearchData() protected method

protected _getSearchData ( Search $search ) : string
$search	Elastica\Search
return	string

_getSearchDataHeader() protected method

protected _getSearchDataHeader ( Search $search ) : array
$search	Elastica\Search
return	array

addSearch() public method

public addSearch ( Search $search, string $key = null )
$search	Elastica\Search
$key	string	Optional key

addSearches() public method

public addSearches ( array $searches )
$searches	array

clearSearches() public method

public clearSearches ( )

getClient() public method

public getClient ( ) : Client
return	Elastica\Client

getSearches() public method

public getSearches ( ) : array \| Search[]
return	array \| Elastica\Search[]

search() public method

public search ( ) : ResultSet
return	ResultSet

setSearchType() public method

public setSearchType ( string $searchType )
$searchType	string

setSearches() public method

public setSearches ( array $searches )
$searches	array

Property Details

$_client protected property

protected Client,Elastica $_client
return	Elastica\Client

$_options protected property

protected array $_options
return	array

$_searches protected property

protected array\|Search[],Elastica $_searches
return	array \| Elastica\Search[]