CirrusSearch\Search\SearchRequestBuilder Class Reference

Build the search request body. More...

Public Member Functions
	__construct (SearchContext $searchContext, Connection $connection, $indexBaseName)
	build ()
	Build the search request.
	getOffset ()
	setOffset ( $offset)
	getLimit ()
	setLimit ( $limit)
	getTimeout ()
	setTimeout ( $timeout)
	getIndex ()
	setIndex (?Index $index)
	getSort ()
	setSort ( $sort)
	getSearchContext ()

Detailed Description

Build the search request body.

Member Function Documentation

build()

CirrusSearch\Search\SearchRequestBuilder::build

(

)

Build the search request.

Returns

\Elastica\Search

getIndex()

CirrusSearch\Search\SearchRequestBuilder::getIndex

(

)

Returns

\Elastica\Index An elastica type suitable for searching against the configured wiki over the host wiki's default connection.

getLimit()

CirrusSearch\Search\SearchRequestBuilder::getLimit

(

)

Returns

int

getOffset()

CirrusSearch\Search\SearchRequestBuilder::getOffset

(

)

Returns

int

getSearchContext()

CirrusSearch\Search\SearchRequestBuilder::getSearchContext

(

)

Returns

SearchContext

getSort()

CirrusSearch\Search\SearchRequestBuilder::getSort

(

)

Returns

string

getTimeout()

CirrusSearch\Search\SearchRequestBuilder::getTimeout

(

)

Returns

string

setIndex()

CirrusSearch\Search\SearchRequestBuilder::setIndex

(

?Index

$index

)

Parameters

?Index

$index

Returns

$this

setLimit()

CirrusSearch\Search\SearchRequestBuilder::setLimit

(

$limit

)

Parameters

int

$limit

Returns

SearchRequestBuilder

setOffset()

CirrusSearch\Search\SearchRequestBuilder::setOffset

(

$offset

)

Parameters

int

$offset

Returns

SearchRequestBuilder

setSort()

CirrusSearch\Search\SearchRequestBuilder::setSort

(

$sort

)

Parameters

string

$sort

Returns

SearchRequestBuilder

setTimeout()

CirrusSearch\Search\SearchRequestBuilder::setTimeout

(

$timeout

)

Parameters

string

$timeout

Returns

SearchRequestBuilder

---

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

• includes/Search/SearchRequestBuilder.php