CirrusSearch\Maintenance\Validators\SpecificAliasValidator Class Reference

Inheritance diagram for CirrusSearch\Maintenance\Validators\SpecificAliasValidator:

Collaboration diagram for CirrusSearch\Maintenance\Validators\SpecificAliasValidator:

Public Member Functions
	__construct (Client $client, $aliasName, $specificIndexName, $startOver, Reindexer $reindexer, array $reindexParams, array $reindexValidators, $reindexAndRemoveOk, Printer $out=null)
	updateFreeIndices (array $add)
	swapAliases (array $add)
Public Member Functions inherited from CirrusSearch\Maintenance\Validators\IndexAliasValidator
	__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
	updateIndices (array $add, array $remove)
	shouldRemoveFromAlias ( $name)
Protected Member Functions inherited from CirrusSearch\Maintenance\Validators\Validator
	checkConfig ( $actual, array $required, $indent=null)
	output ( $message, $channel=null)
	outputIndented ( $message)

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

Constructor & Destructor Documentation

__construct()

CirrusSearch\Maintenance\Validators\SpecificAliasValidator::__construct	(	Client	$client,
			$aliasName,
			$specificIndexName,
			$startOver,
		Reindexer	$reindexer,
		array	$reindexParams,
		array	$reindexValidators,
			$reindexAndRemoveOk,
		Printer	$out = null )

Parameters

Client	$client
string	$aliasName
string	$specificIndexName
bool	$startOver
Reindexer	$reindexer
array	$reindexParams
Validator[]	$reindexValidators
bool	$reindexAndRemoveOk
Printer | null	$out

Member Function Documentation

shouldRemoveFromAlias()

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

protected

Parameters

string

$name

Returns

bool

Reimplemented from CirrusSearch\Maintenance\Validators\IndexAliasValidator.

swapAliases()

CirrusSearch\Maintenance\Validators\SpecificAliasValidator::swapAliases

(

array

$add

)

Parameters

array

$add

Returns

Status

updateFreeIndices()

CirrusSearch\Maintenance\Validators\SpecificAliasValidator::updateFreeIndices

(

array

$add

)

Parameters

string[]

$add

Returns

Status

updateIndices()

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

protected

Parameters

string[]	$add
string[]	$remove

Returns

Status

Reimplemented from CirrusSearch\Maintenance\Validators\IndexAliasValidator.

---

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

• includes/Maintenance/Validators/SpecificAliasValidator.php