CirrusSearch\ExplainPrinter Class Reference

Formats the result of elasticsearch explain to a (slightly) more readable html format than raw json. More...

Public Member Functions
	__construct ( $type)
	format (array $queryResult)

Protected Member Functions
	processExplain (array $explanation)
	Only visible for test purposes.

Detailed Description

Formats the result of elasticsearch explain to a (slightly) more readable html format than raw json.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html

Constructor & Destructor Documentation

__construct()

CirrusSearch\ExplainPrinter::__construct

(

$type

)

Parameters

string

$type

Type of explain to print

Member Function Documentation

format()

CirrusSearch\ExplainPrinter::format

(

array

$queryResult

)

Parameters

array[]

$queryResult

Elasticsearch result

Returns

string

processExplain()

CirrusSearch\ExplainPrinter::processExplain ( array $explanation )

protected

Only visible for test purposes.

Parameters

array

$explanation

Returns

string

---

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

• includes/ExplainPrinter.php