MongoDB\ChangeStream Class Reference

Inheritance diagram for MongoDB\ChangeStream:

Public Member Functions
	__construct (ChangeStreamIterator $iterator, callable $resumeCallable)
	current ()
	getCursorId ()
	getResumeToken ()
	Returns the resume token for the iterator's current position.
	key ()
	next ()
	rewind ()
	valid ()

Public Attributes
const	CURSOR_NOT_FOUND = 43

Member Function Documentation

current()

MongoDB\ChangeStream::current

(

)

See also

https://php.net/iterator.current

Return values

mixed

getCursorId()

MongoDB\ChangeStream::getCursorId

(

)

Return values

CursorId

getResumeToken()

MongoDB\ChangeStream::getResumeToken

(

)

Returns the resume token for the iterator's current position.

Null may be returned if no change documents have been iterated and the server did not include a postBatchResumeToken in its aggregate or getMore command response.

Return values

array|object|null

key()

MongoDB\ChangeStream::key

(

)

See also

https://php.net/iterator.key

Return values

mixed

next()

MongoDB\ChangeStream::next

(

)

See also

https://php.net/iterator.next

Return values

void

Exceptions

ResumeTokenException

rewind()

MongoDB\ChangeStream::rewind

(

)

See also

https://php.net/iterator.rewind

Return values

void

Exceptions

ResumeTokenException

valid()

MongoDB\ChangeStream::valid

(

)

See also

https://php.net/iterator.valid

Return values

boolean

Member Data Documentation

CURSOR_NOT_FOUND

const MongoDB\ChangeStream::CURSOR_NOT_FOUND = 43

Deprecated

1.4

Todo

Remove this in 2.0 (see: PHPLIB-360)

---

The documentation for this class was generated from the following file:

• cache/stores/mongodb/MongoDB/ChangeStream.php