Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/cache/stores/mongodb/MongoDB/ -> MapReduceResult.php (source)

[Source view]

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

(no description)

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

Defines 1 class

MapReduceResult:: (5 methods):
  __construct()
  getCounts()
  getExecutionTimeMS()
  getIterator()
  getTiming()


Class: MapReduceResult  - X-Ref

Result class for mapReduce command results.

This class allows for iteration of mapReduce results irrespective of the
output method (e.g. inline, collection) via the IteratorAggregate interface.
It also provides access to command statistics.

__construct(callable $getIterator, stdClass $result)   X-Ref

param: callable $getIterator Callback that returns a Traversable for mapReduce results
param: stdClass $result      Result document from the mapReduce command

getCounts()   X-Ref
Returns various count statistics from the mapReduce command.

return: array

getExecutionTimeMS()   X-Ref
Return the command execution time in milliseconds.

return: integer

getIterator()   X-Ref
Return the mapReduce results as a Traversable.

return: Traversable

getTiming()   X-Ref
Returns various timing statistics from the mapReduce command.

Note: timing statistics are only available if the mapReduce command's
"verbose" option was true; otherwise, an empty array will be returned.

return: array