CirrusSearch
Elasticsearch-powered search for MediaWiki
Loading...
Searching...
No Matches
CirrusSearch\MultiSearchRequestLog Class Reference

Extending from SearchRequestLog doesn't quite feel right, but there is a good amount of shared code. More...

+ Inheritance diagram for CirrusSearch\MultiSearchRequestLog:
+ Collaboration diagram for CirrusSearch\MultiSearchRequestLog:

Public Member Functions

 getLogVariables ()
 Not sure what's best to return here, primarily we need whatever would be interesting when looking at error logging.
 
 getRequests ()
 
- Public Member Functions inherited from CirrusSearch\SearchRequestLog
 __construct (\Elastica\Client $client, $description, $queryType, array $extra=[], array $namespaces=null)
 
 setCachedResult (array $extra)
 
 finish ()
 Called when the network request has finished.
 
 isCachedResponse ()
 
 getElasticTookMs ()
 
- Public Member Functions inherited from CirrusSearch\BaseRequestLog
 __construct ( $description, $queryType, array $extra=[])
 
 start ()
 Called when the network request is started.
 
 getTookMs ()
 
 getDescription ()
 
 getQueryType ()
 
 formatDescription ()
 Perform a quick and dirty replacement for $this->description when it's not going through monolog.
 

Protected Member Functions

 extractRequestVariables ( $requestData)
 
- Protected Member Functions inherited from CirrusSearch\SearchRequestLog
 extractResponseVariables ( $responseData)
 
 extractHits (array $responseData)
 

Additional Inherited Members

- Protected Attributes inherited from CirrusSearch\SearchRequestLog
 $request
 
 $response
 
- Protected Attributes inherited from CirrusSearch\BaseRequestLog
 $description
 
 $queryType
 
 $extra
 
 $startTime
 
 $endTime
 

Detailed Description

Extending from SearchRequestLog doesn't quite feel right, but there is a good amount of shared code.

think about best way.

Member Function Documentation

◆ extractRequestVariables()

CirrusSearch\MultiSearchRequestLog::extractRequestVariables ( $requestData)
protected
Parameters
array$requestData
Returns
array

Reimplemented from CirrusSearch\SearchRequestLog.

◆ getLogVariables()

CirrusSearch\MultiSearchRequestLog::getLogVariables ( )

Not sure what's best to return here, primarily we need whatever would be interesting when looking at error logging.

For now this just generates a context for the first request and ignores the existence of the rest.

Basically this is known to be wrong, but not sure what to do instead.

Returns
array

@phan-suppress-next-line PhanTypeMismatchArgumentInternal getData() actually returns array|string

Reimplemented from CirrusSearch\SearchRequestLog.

◆ getRequests()

CirrusSearch\MultiSearchRequestLog::getRequests ( )
Returns
array[]

@phan-suppress-next-line PhanTypeMismatchArgumentInternal getData() actually returns array|string

Reimplemented from CirrusSearch\SearchRequestLog.


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