CirrusSearch\Dispatch\SearchQueryDispatchService Interface Reference

The Search query dispatch service. More...

Inheritance diagram for CirrusSearch\Dispatch\SearchQueryDispatchService:

Public Member Functions
	bestRoute (SearchQuery $query)
	Determine the best route for the $query.

Public Attributes
const	CIRRUS_DEFAULTS_SCORE = 0.0001
	Score used by cirrus defaults.

Detailed Description

The Search query dispatch service.

Based on a SearchQuery and the SearchQueryRoute that have been declared find the best possible route for this query.

All routes are evaluated the best one is returned.

• If multiple routes gives equal score the first one wins
• If multiple routes give the max score of 1 then the system fails
• If no routes is found the system fails

See also

SearchQueryRoute

Member Function Documentation

bestRoute()

CirrusSearch\Dispatch\SearchQueryDispatchService::bestRoute

(

SearchQuery

$query

)

Determine the best route for the $query.

Parameters

SearchQuery

$query

Returns

SearchQueryRoute

Member Data Documentation

CIRRUS_DEFAULTS_SCORE

const CirrusSearch\Dispatch\SearchQueryDispatchService::CIRRUS_DEFAULTS_SCORE = 0.0001

Score used by cirrus defaults.

Anything below is unlikely to be selected as cirrus defaults are made to catchup all query types.

---

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

• includes/Dispatch/SearchQueryDispatchService.php