PhpOrient Protocols Common ClusterMap

PhpOrient\Protocols\Common\ClusterMap

Class ClusterMap

• Class name: ClusterMap
• Namespace: PhpOrient\Protocols\Common
• This class implements: PhpOrient\Protocols\Common\ConfigurableInterface, ArrayAccess, Countable, Iterator

Properties

$dataClusters

    protected array $dataClusters

• Visibility: protected

$reverseMap

    protected array $reverseMap

• Visibility: protected

$reverseIDMap

    protected array $reverseIDMap

• Visibility: protected

$servers

    protected integer $servers

• Visibility: protected

$release

    protected string $release

• Visibility: protected

$internal_position

    protected mixed $internal_position

• Visibility: protected

Methods

getServers

    integer PhpOrient\Protocols\Common\ClusterMap::getServers()

• Visibility: public

getRelease

    string PhpOrient\Protocols\Common\ClusterMap::getRelease()

• Visibility: public

configure

    \PhpOrient\Protocols\Common\ConfigurableInterface PhpOrient\Protocols\Common\ConfigurableInterface::configure(array $options)

Configure the object.

• Visibility: public
• This method is defined by PhpOrient\Protocols\Common\ConfigurableInterface

Arguments

• $options array

  The options for the object.

getIdList

    array<mixed,integer>|array<mixed,string> PhpOrient\Protocols\Common\ClusterMap::getIdList()

Return the list of cluster IDs

• Visibility: public

getClusterID

    integer|null PhpOrient\Protocols\Common\ClusterMap::getClusterID($name)

Alias for @see ClusterList::offsetGet

• Visibility: public

Arguments

• $name mixed

dropClusterID

    mixed PhpOrient\Protocols\Common\ClusterMap::dropClusterID($ID)

Remove a cluster by ID

• Visibility: public

Arguments

• $ID mixed

offsetExists

    boolean PhpOrient\Protocols\Common\ClusterMap::offsetExists(mixed $name)

(PHP 5 >= 5.0.0)

Whether a offset exists

• Visibility: public

Arguments

• $name mixed

  An offset to check for.

offsetGet

    integer|null PhpOrient\Protocols\Common\ClusterMap::offsetGet(mixed $name)

(PHP 5 >= 5.0.0)

Offset to retrieve

• Visibility: public

Arguments

• $name mixed

  The offset to retrieve.

offsetSet

    void PhpOrient\Protocols\Common\ClusterMap::offsetSet(mixed $name, mixed $value)

(PHP 5 >= 5.0.0)

Offset to set

• Visibility: public

Arguments

• $name mixed

  The offset to assign the value to.

• $value mixed

  The value to set.

offsetUnset

    void PhpOrient\Protocols\Common\ClusterMap::offsetUnset(mixed $name)

(PHP 5 >= 5.0.0)

Offset to unset

• Visibility: public

Arguments

• $name mixed

  The offset to unset.

count

    integer PhpOrient\Protocols\Common\ClusterMap::count()

(PHP 5 >= 5.1.0)

Count elements of an object

• Visibility: public

next

    void PhpOrient\Protocols\Common\ClusterMap::next()

(PHP 5 >= 5.0.0)

Move forward to next element

• Visibility: public

key

    mixed PhpOrient\Protocols\Common\ClusterMap::key()

(PHP 5 >= 5.0.0)

Return the key of the current element

• Visibility: public

valid

    boolean PhpOrient\Protocols\Common\ClusterMap::valid()

(PHP 5 >= 5.0.0)

Checks if current position is valid

• Visibility: public

rewind

    void PhpOrient\Protocols\Common\ClusterMap::rewind()

(PHP 5 >= 5.0.0)

Rewind the Iterator to the first element

• Visibility: public

current

    mixed PhpOrient\Protocols\Common\ClusterMap::current()

(PHP 5 >= 5.0.0)

Return the current element

• Visibility: public

fromConfig

    static PhpOrient\Protocols\Common\ClusterMap::fromConfig(array $options)

Return a new class instance configured from the given options.

• Visibility: public
• This method is static.

Arguments

• $options array

  The options for the newly created class instance.