CirrusSearch\Dispatch\BasicSearchQueryRoute Class Reference

Basic SearchQuery routing functionality which produces a constant score when successful, 0.0 otherwise. More...

Inheritance diagram for CirrusSearch\Dispatch\BasicSearchQueryRoute:

Collaboration diagram for CirrusSearch\Dispatch\BasicSearchQueryRoute:

Public Member Functions
	__construct ( $searchEngineEntryPoint, array $namespaces, array $acceptableQueryClasses, $profileContext, $score)
	score (\CirrusSearch\Search\SearchQuery $query)
	getSearchEngineEntryPoint ()
	The entry point used in the search engine:
	getProfileContext ()
	The SearchProfile context to use when this route is chosen.
Public Member Functions inherited from CirrusSearch\Dispatch\SearchQueryRoute
	score (SearchQuery $query)
	Compute a score for this particular $query.

Detailed Description

Basic SearchQuery routing functionality which produces a constant score when successful, 0.0 otherwise.

Inspect the requested namespaces and the classes of the query.

Constructor & Destructor Documentation

__construct()

CirrusSearch\Dispatch\BasicSearchQueryRoute::__construct	(		$searchEngineEntryPoint,
		array	$namespaces,
		array	$acceptableQueryClasses,
			$profileContext,
			$score )

Parameters

string	$searchEngineEntryPoint
int[]	$namespaces
string[]	$acceptableQueryClasses
string	$profileContext
float	$score

Member Function Documentation

getProfileContext()

CirrusSearch\Dispatch\BasicSearchQueryRoute::getProfileContext

(

)

The SearchProfile context to use when this route is chosen.

Returns

string

Implements CirrusSearch\Dispatch\SearchQueryRoute.

getSearchEngineEntryPoint()

CirrusSearch\Dispatch\BasicSearchQueryRoute::getSearchEngineEntryPoint

(

)

The entry point used in the search engine:

• searchText
• nearMatch
• completionSearch

Returns

string

Implements CirrusSearch\Dispatch\SearchQueryRoute.

score()

CirrusSearch\Dispatch\BasicSearchQueryRoute::score

(

\CirrusSearch\Search\SearchQuery

$query

)

Parameters

\CirrusSearch\Search\SearchQuery

$query

Returns

float

---

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

• includes/Dispatch/BasicSearchQueryRoute.php