MongoDB\BSON\Iterator::__construct »

« MongoDB\BSON\PackedArray::__toString

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 function __construct()

public function current(): mixed

public function key(): string|int

public function next(): void

public function rewind(): void

public function 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

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

User Contributed Notes

There are no user contributed notes for this page.