CirrusSearch\Maintenance\Validators\Validator Class Reference

Inheritance diagram for CirrusSearch\Maintenance\Validators\Validator:

Public Member Functions
	__construct (Printer $out)
	validate ()
	printDebugCheckConfig ( $print=true)

Protected Member Functions
	checkConfig ( $actual, array $required, $indent=null)
	output ( $message, $channel=null)
	outputIndented ( $message)

Protected Attributes
	$out
	$printDebugCheckConfig = false

Constructor & Destructor Documentation

__construct()

CirrusSearch\Maintenance\Validators\Validator::__construct

(

Printer

$out

)

Parameters

Printer

$out

to relay output to.

Member Function Documentation

checkConfig()

CirrusSearch\Maintenance\Validators\Validator::checkConfig ( $actual, array $required, $indent = null )

protected

Parameters

mixed	$actual
array	$required
string | null	$indent

Returns

bool

output()

CirrusSearch\Maintenance\Validators\Validator::output ( $message, $channel = null )

protected

Parameters

string	$message
mixed | null	$channel

outputIndented()

CirrusSearch\Maintenance\Validators\Validator::outputIndented ( $message )

protected

Parameters

string

$message

printDebugCheckConfig()

CirrusSearch\Maintenance\Validators\Validator::printDebugCheckConfig

(

$print = true

)

Parameters

bool

$print

validate()

CirrusSearch\Maintenance\Validators\Validator::validate ( )

abstract

Returns

\Status

Reimplemented in CirrusSearch\Maintenance\Validators\AnalyzersValidator, CirrusSearch\Maintenance\Validators\IndexAliasValidator, CirrusSearch\Maintenance\Validators\MappingValidator, CirrusSearch\Maintenance\Validators\MaxShardsPerNodeValidator, CirrusSearch\Maintenance\Validators\NumberOfShardsValidator, CirrusSearch\Maintenance\Validators\ReplicaRangeValidator, and CirrusSearch\Maintenance\Validators\ShardAllocationValidator.

---

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

• includes/Maintenance/Validators/Validator.php