Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/cache/stores/mongodb/MongoDB/ -> ChangeStream.php (source)

[Source view]

Differences Between: [Versions 310 and 400] [Versions 39 and 400] [Versions 400 and 401]

(no description)

File Size: 274 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ChangeStream:: (12 methods):
  __construct()
  current()
  getCursorId()
  getResumeToken()
  key()
  next()
  rewind()
  valid()
  isResumableError()
  onIteration()
  resume()
  resumeOrThrow()


Class: ChangeStream  - X-Ref

Iterator for a change stream.

__construct(ChangeStreamIterator $iterator, callable $resumeCallable)   X-Ref

param: ChangeStreamIterator $iterator
param: callable             $resumeCallable

current()   X-Ref

return: mixed

getCursorId()   X-Ref

return: CursorId

getResumeToken()   X-Ref
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: array|object|null

key()   X-Ref

return: mixed

next()   X-Ref

return: void

rewind()   X-Ref

return: void

valid()   X-Ref

return: boolean

isResumableError(RuntimeException $exception)   X-Ref
Determines if an exception is a resumable error.

return: boolean
param: RuntimeException $exception

onIteration($incrementKey)   X-Ref
Perform housekeeping after an iteration event.

param: boolean $incrementKey Increment $key if there is a current result

resume()   X-Ref
Recreates the ChangeStreamIterator after a resumable server error.

return: void

resumeOrThrow(RuntimeException $exception)   X-Ref
Either resumes after a resumable error or re-throws the exception.

param: RuntimeException $exception