Возвращает опцию "mode" объекта ReadPreference в виде строки

# MongoDB\Driver\ReadPreference::getModeString

(mongodb >=1.7.0)

MongoDB\Driver\ReadPreference::getModeString — Возвращает опцию "mode" объекта ReadPreference в виде строки

### Описание

final public function MongoDB\Driver\ReadPreference::getModeString(): string

### Список параметров

Сигнатура функции не содержит параметров.

### Возвращаемые значения

Метод возвращает опцию "mode" объекта ReadPreference в виде строки.

### Ошибки

- При ошибке парсинга аргумента метод выбрасывает исключение MongoDB\Driver\Exception\InvalidArgumentException.

### Примеры

Пример #1 Пример возврата опции методом MongoDB\Driver\ReadPreference::getModeString()

    <?php

    $rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::PRIMARY);
    var_dump($rp->getModeString());

    $rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED);
    var_dump($rp->getModeString());

    $rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY);
    var_dump($rp->getModeString());

    $rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::SECONDARY_PREFERRED);
    var_dump($rp->getModeString());

    $rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::NEAREST);
    var_dump($rp->getModeString());

    ?>

Результат выполнения приведённого примера:

    string(7) "primary"
    string(16) "primaryPreferred"
    string(9) "secondary"
    string(18) "secondaryPreferred"
    string(7) "nearest"

### Смотрите также

- MongoDB\Driver\ReadPreference::getMode() - Возвращает опцию "mode" объекта ReadPreference
- » Документация к Read Preference

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open