CirrusSearch\Maintenance\Validators\IndexAliasValidator Class Reference

Inheritance diagram for CirrusSearch\Maintenance\Validators\IndexAliasValidator:

Collaboration diagram for CirrusSearch\Maintenance\Validators\IndexAliasValidator:

Public Member Functions
	__construct (Client $client, $aliasName, $specificIndexName, $startOver, Printer $out)
	validate ()
Public Member Functions inherited from CirrusSearch\Maintenance\Validators\Validator
	__construct (Printer $out)
	printDebugCheckConfig ( $print=true)

Protected Member Functions
	shouldRemoveFromAlias ( $name)
	updateIndices (array $add, array $remove)
Protected Member Functions inherited from CirrusSearch\Maintenance\Validators\Validator
	checkConfig ( $actual, array $required, $indent=null)
	output ( $message, $channel=null)
	outputIndented ( $message)

Protected Attributes
	$client
	$aliasName
	$specificIndexName
	$create = []
	$remove = []
Protected Attributes inherited from CirrusSearch\Maintenance\Validators\Validator
	$out
	$printDebugCheckConfig = false

Constructor & Destructor Documentation

__construct()

CirrusSearch\Maintenance\Validators\IndexAliasValidator::__construct	(	Client	$client,
			$aliasName,
			$specificIndexName,
			$startOver,
		Printer	$out )

Parameters

Client	$client
string	$aliasName
string	$specificIndexName
bool	$startOver
Printer	$out

Member Function Documentation

shouldRemoveFromAlias()

CirrusSearch\Maintenance\Validators\IndexAliasValidator::shouldRemoveFromAlias ( $name )

abstractprotected

Parameters

string

$name

Returns

bool

Reimplemented in CirrusSearch\Maintenance\Validators\IndexAllAliasValidator, and CirrusSearch\Maintenance\Validators\SpecificAliasValidator.

updateIndices()

CirrusSearch\Maintenance\Validators\IndexAliasValidator::updateIndices ( array $add, array $remove )

protected

Parameters

string[]	$add	Array of indices to add
string[]	$remove	Array of indices to remove

Returns

Status

Reimplemented in CirrusSearch\Maintenance\Validators\IndexAllAliasValidator, and CirrusSearch\Maintenance\Validators\SpecificAliasValidator.

validate()

CirrusSearch\Maintenance\Validators\IndexAliasValidator::validate

(

)

Returns

Status

Reimplemented from CirrusSearch\Maintenance\Validators\Validator.

---

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

• includes/Maintenance/Validators/IndexAliasValidator.php