Возвращает ключ текущего элемента

# MongoDB\BSON\Iterator::key

(mongodb >=1.16.0)

MongoDB\BSON\Iterator::key — Возвращает ключ текущего элемента

### Описание

public function MongoDB\BSON\Iterator::key(): string|int

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

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

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

Возвращает ключ текущего элемента. При итерации BSON-документа ключом всегда будет строка (string). При итерации массива BSON ключом будет целое число (int).

### Ошибки

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

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

- Iterator::key() - Возвращает ключ текущего элемента

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