CirrusSearch\BaseRequestLog Class Reference

Inheritance diagram for CirrusSearch\BaseRequestLog:

Collaboration diagram for CirrusSearch\BaseRequestLog:

Public Member Functions
	__construct ( $description, $queryType, array $extra=[])
	start ()
	Called when the network request is started.
	finish ()
	Called when the network request has finished.
	getTookMs ()
	getDescription ()
	getQueryType ()
	formatDescription ()
	Perform a quick and dirty replacement for $this->description when it's not going through monolog.
Public Member Functions inherited from CirrusSearch\RequestLog
	getElasticTookMs ()
	isCachedResponse ()
	getLogVariables ()
	getRequests ()

Protected Attributes
	$description
	$queryType
	$extra
	$startTime
	$endTime

Constructor & Destructor Documentation

__construct()

CirrusSearch\BaseRequestLog::__construct	(		$description,
			$queryType,
		array	$extra = [] )

Parameters

string	$description
string	$queryType
array	$extra

Member Function Documentation

finish()

CirrusSearch\BaseRequestLog::finish

(

)

Called when the network request has finished.

Implements CirrusSearch\RequestLog.

Reimplemented in CirrusSearch\BulkUpdateRequestLog, and CirrusSearch\SearchRequestLog.

formatDescription()

CirrusSearch\BaseRequestLog::formatDescription

(

)

Perform a quick and dirty replacement for $this->description when it's not going through monolog.

It replaces {foo} with the value of foo

Returns

string

Implements CirrusSearch\RequestLog.

getDescription()

CirrusSearch\BaseRequestLog::getDescription

(

)

Returns

string

Implements CirrusSearch\RequestLog.

getQueryType()

CirrusSearch\BaseRequestLog::getQueryType

(

)

Returns

string

Implements CirrusSearch\RequestLog.

getTookMs()

CirrusSearch\BaseRequestLog::getTookMs

(

)

Returns

int|null

Implements CirrusSearch\RequestLog.

start()

CirrusSearch\BaseRequestLog::start

(

)

Called when the network request is started.

Implements CirrusSearch\RequestLog.

---

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

• includes/BaseRequestLog.php