CirrusSearch\Search\MSearchRequests Class Reference

Holds the Elastic search requests meant to be sent to the _msearch endpoint. More...

Public Member Functions
	addRequest ( $key, Search $search)
	getRequests ()
	toMSearchResponses (array $resultSets)
	failure (Status $status)
	dumpQuery ( $description)

Static Public Member Functions
static	build ( $key, Search $search)

Detailed Description

Holds the Elastic search requests meant to be sent to the _msearch endpoint.

Users attach a search request identified by a key and after the search requests have been submitted to the backend the response can later then be retrieved using that same key. @See MSearchResponses

Member Function Documentation

addRequest()

CirrusSearch\Search\MSearchRequests::addRequest	(		$key,
		Search	$search )

Parameters

string	$key
Search	$search

build()

static CirrusSearch\Search\MSearchRequests::build ( $key, Search $search )

static

Parameters

string	$key
Search	$search

Returns

self

dumpQuery()

CirrusSearch\Search\MSearchRequests::dumpQuery

(

$description

)

Parameters

string

$description

Returns

Status

failure()

CirrusSearch\Search\MSearchRequests::failure

(

Status

$status

)

Parameters

Status

$status

Returns

MSearchResponses

getRequests()

CirrusSearch\Search\MSearchRequests::getRequests

(

)

Returns

Search[]

toMSearchResponses()

CirrusSearch\Search\MSearchRequests::toMSearchResponses

(

array

$resultSets

)

Parameters

\Elastica\ResultSet[]

$resultSets

Returns

MSearchResponses

---

The documentation for this class was generated from the following file:

• includes/Search/MSearchRequests.php