CirrusSearch\CirrusDebugOptions Class Reference

Cirrus debug options generally set via unofficial URI param (&cirrusXYZ=ZYX) More...

Public Member Functions
	getCirrusCompletionVariant ()
	isCirrusDumpQuery ()
	isCirrusDumpQueryAST ()
	isCirrusDumpResult ()
	getCirrusExplainFormat ()
	getCirrusMLRModel ()
	isDumpAndDie ()
	isReturnRaw ()
	applyDebugOptions (Query $query)
	mustNeverBeCached ()
	isBackwardCompatible ()

Static Public Member Functions
static	fromRequest (\WebRequest $request)
static	defaultOptions ()
	Default options (no debug options set)
static	forDumpingQueriesInUnitTests ( $backCompat=true)
	Dump the query but not die.
static	forRelevanceTesting ( $withExplain=null)

Detailed Description

Cirrus debug options generally set via unofficial URI param (&cirrusXYZ=ZYX)

Member Function Documentation

applyDebugOptions()

CirrusSearch\CirrusDebugOptions::applyDebugOptions

(

Query

$query

)

Parameters

Query

$query

Returns

Query

defaultOptions()

static CirrusSearch\CirrusDebugOptions::defaultOptions ( )

static

Default options (no debug options set)

Returns

CirrusDebugOptions

forDumpingQueriesInUnitTests()

static CirrusSearch\CirrusDebugOptions::forDumpingQueriesInUnitTests ( $backCompat = true )

static

Dump the query but not die.

Only useful in Unit tests.

Parameters

bool

$backCompat

used by unit tests when cross-repo dependencies need to preserve compatiblity until all patches are merged.

Returns

CirrusDebugOptions

forRelevanceTesting()

static CirrusSearch\CirrusDebugOptions::forRelevanceTesting ( $withExplain = null )

static

Parameters

string | null

$withExplain

Returns

CirrusDebugOptions

fromRequest()

static CirrusSearch\CirrusDebugOptions::fromRequest ( \WebRequest $request )

static

Parameters

\WebRequest

$request

Returns

CirrusDebugOptions

getCirrusCompletionVariant()

CirrusSearch\CirrusDebugOptions::getCirrusCompletionVariant

(

)

Returns

null|string[]

getCirrusExplainFormat()

CirrusSearch\CirrusDebugOptions::getCirrusExplainFormat

(

)

Returns

string|null The formatting to apply, or null to return raw explains

getCirrusMLRModel()

CirrusSearch\CirrusDebugOptions::getCirrusMLRModel

(

)

Returns

string|null

isCirrusDumpQuery()

CirrusSearch\CirrusDebugOptions::isCirrusDumpQuery

(

)

Returns

bool

isCirrusDumpQueryAST()

CirrusSearch\CirrusDebugOptions::isCirrusDumpQueryAST

(

)

Returns

bool

isCirrusDumpResult()

CirrusSearch\CirrusDebugOptions::isCirrusDumpResult

(

)

Returns

bool

isDumpAndDie()

CirrusSearch\CirrusDebugOptions::isDumpAndDie

(

)

Returns

bool

isReturnRaw()

CirrusSearch\CirrusDebugOptions::isReturnRaw

(

)

Returns

bool true if raw data (query or results) needs to be returned

mustNeverBeCached()

CirrusSearch\CirrusDebugOptions::mustNeverBeCached

(

)

Returns

bool True when queries built with this set of debug options must not have their results cached and returned to other users.

---

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

• includes/CirrusDebugOptions.php