PHP Manual
MongoDB\BSON
The MongoDB\BSON\Iterator class

The MongoDB\BSON\Iterator class

(mongodb >=1.16.0)

Introduction

Iterator used to iterate a BSON document or array.

Class synopsis

final class MongoDB\BSON\Iterator implements Iterator {

/* Methods */

final private __construct()

public current(): mixed

public key(): string|int

public next(): void

public rewind(): void

public valid(): bool

}

Table of Contents

MongoDB\BSON\Iterator::__construct — Construct a new BSON iterator (unused)
MongoDB\BSON\Iterator::current — Returns the current element
MongoDB\BSON\Iterator::key — Returns the key of the current element
MongoDB\BSON\Iterator::next — Advances the iterator to next element
MongoDB\BSON\Iterator::rewind — Rewinds the Iterator to the first element
MongoDB\BSON\Iterator::valid — Checks if current position is valid