CirrusSearch\Maintenance\RunSearch Class Reference

Inheritance diagram for CirrusSearch\Maintenance\RunSearch:

Collaboration diagram for CirrusSearch\Maintenance\RunSearch:

Public Member Functions
	finalSetup (SettingsBuilder $settingsBuilder)
	execute ()
	consume ( $query)
	Transform the search request into a JSON string representing the search result.
Public Member Functions inherited from CirrusSearch\Maintenance\Maintenance
	runChild ( $maintClass, $classFile=null)
	getConnection ( $cluster=null)
	getSearchConfig ()
	getMetaStore (Connection $conn=null)
	loadSpecialVars ()
	Execute a callback function at the end of initialisation.
	done ()
	Call to signal that execution of this maintenance script is complete so the next one gets the right indentation.
	output ( $message, $channel=null)
	outputIndented ( $message)
	error ( $err, $die=0)

Protected Member Functions
	applyGlobals ()
	Applies global variables provided as the options CLI argument to override current settings.
	processSuggestionSet (SearchSuggestionSet $value)
	Extract data from a search suggestions set.
	processArchiveResult (IResultWrapper $value)
	Extract data from archive search results.
	searchArchive ( $query)
	Search for term in the archive.
	searchFor ( $query)
	Transform the search request into a Status object representing the search result.
Protected Member Functions inherited from CirrusSearch\Maintenance\Maintenance
	disablePoolCountersAndLogging ()
	Disable all pool counters and cirrus query logs.
	maybeCreateMetastore ()
	Create metastore only if the alias does not already exist.
	requireCirrusReady ()
	getBackCompatOption (string $current, string $bc, bool $required=true)
	Provides support for backward compatible CLI options.
	unwrap (Status $status)
	Helper method for Status returning methods, such as via ConfigUtils.

Protected Attributes
	$indexBaseName

Additional Inherited Members
Static Protected Attributes inherited from CirrusSearch\Maintenance\Maintenance
static	$indent = null

Constructor & Destructor Documentation

__construct()

CirrusSearch\Maintenance\RunSearch::__construct

(

)

Reimplemented from CirrusSearch\Maintenance\Maintenance.

Member Function Documentation

consume()

CirrusSearch\Maintenance\RunSearch::consume

(

$query

)

Transform the search request into a JSON string representing the search result.

Parameters

string

$query

Returns

string JSON object

finalSetup()

CirrusSearch\Maintenance\RunSearch::finalSetup

(

SettingsBuilder

$settingsBuilder

)

Reimplemented from CirrusSearch\Maintenance\Maintenance.

processArchiveResult()

CirrusSearch\Maintenance\RunSearch::processArchiveResult ( IResultWrapper $value )

protected

Extract data from archive search results.

Parameters

IResultWrapper

$value

Returns

array

processSuggestionSet()

CirrusSearch\Maintenance\RunSearch::processSuggestionSet ( SearchSuggestionSet $value )

protected

Extract data from a search suggestions set.

Parameters

SearchSuggestionSet

$value

Returns

array

searchArchive()

CirrusSearch\Maintenance\RunSearch::searchArchive ( $query )

protected

Search for term in the archive.

Parameters

string

$query

Returns

Status<IResultWrapper>

searchFor()

CirrusSearch\Maintenance\RunSearch::searchFor ( $query )

protected

Transform the search request into a Status object representing the search result.

Varies based on CLI input argument type.

Parameters

string

$query

Returns

Status<CirrusSearch\Search\CirrusSearchResultSet|SearchSuggestionSet|IResultWrapper>

---

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

• maintenance/RunSearch.php