Retorna a chave do elemento atual

# MongoDB\BSON\Iterator::key

(mongodb >=1.16.0)

MongoDB\BSON\Iterator::key — Retorna a chave do elemento atual

### Descrição

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

### Parâmetros

Esta função não possui parâmetros.

### Valor Retornado

Retorna a chave do elemento atual. Ao iterar sobre um documento BSON, a chave sempre será uma string. Ao iterar sobre um array BSON, a chave será um int.

### Erros/Exceções

- Lança uma exceção MongoDB\Driver\Exception\InvalidArgumentException em caso de erro ao analisar argumentos.
- Lança uma MongoDB\Driver\Exception\LogicException se o iterador não for válido.

### Veja Também

- Iterator::key() - Retorna a chave do elemento atual

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