CirrusSearch\Assignment\ConstantAssignment Class Reference

Inheritance diagram for CirrusSearch\Assignment\ConstantAssignment:

Collaboration diagram for CirrusSearch\Assignment\ConstantAssignment:

Public Member Functions
	__construct (array $servers)
	uniqueId ( $cluster)
	getServerList ( $cluster=null)
	getSearchCluster ()
	getWritableClusters (string $updateGroup)
	getAllKnownClusters ()
	hasCluster (string $clusterName)
	canWriteToCluster ( $clusterName, $updateGroup)
	getCrossClusterName ()

Constructor & Destructor Documentation

__construct()

CirrusSearch\Assignment\ConstantAssignment::__construct

(

array

$servers

)

Parameters

string[] | array[]

$servers

Elastica connection configuration

Member Function Documentation

canWriteToCluster()

CirrusSearch\Assignment\ConstantAssignment::canWriteToCluster	(		$clusterName,
			$updateGroup )

Parameters

string	$clusterName
string	$updateGroup	UpdateGroup::* constant

Returns

bool True when the named cluster is writable for this kind of update

Implements CirrusSearch\Assignment\ClusterAssignment.

getAllKnownClusters()

CirrusSearch\Assignment\ConstantAssignment::getAllKnownClusters

(

)

Returns

string[] List all known cluster groups

Implements CirrusSearch\Assignment\ClusterAssignment.

getCrossClusterName()

CirrusSearch\Assignment\ConstantAssignment::getCrossClusterName

(

)

Returns

string|null The name to use to refer to this wikis group in cross-cluster-search.

Implements CirrusSearch\Assignment\ClusterAssignment.

getSearchCluster()

CirrusSearch\Assignment\ConstantAssignment::getSearchCluster

(

)

Returns

string Name of the cluster group to search against

Implements CirrusSearch\Assignment\ClusterAssignment.

getServerList()

CirrusSearch\Assignment\ConstantAssignment::getServerList

(

$cluster = null

)

Parameters

string | null

$cluster

Returns

string[]|array[]

Implements CirrusSearch\Assignment\ClusterAssignment.

getWritableClusters()

CirrusSearch\Assignment\ConstantAssignment::getWritableClusters

(

string

$updateGroup

)

Parameters

string

$updateGroup

UpdateGroup::* constant

Returns

string[] List of the cluster groups to send writes to

Implements CirrusSearch\Assignment\ClusterAssignment.

hasCluster()

CirrusSearch\Assignment\ConstantAssignment::hasCluster

(

string

$clusterName

)

Parameters

string

$clusterName

Returns

bool True if the cluster is defined

Implements CirrusSearch\Assignment\ClusterAssignment.

uniqueId()

CirrusSearch\Assignment\ConstantAssignment::uniqueId

(

$cluster

)

Parameters

string

$cluster

The cluster to id.

Returns

string An identifier that unique describes the connection properties. Instances of the same implementation will return same value for same configuration.

Implements CirrusSearch\Assignment\ClusterAssignment.

---

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

• includes/Assignment/ConstantAssignment.php