Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
<?php
/*
< * Copyright 2017 MongoDB, Inc.
> * Copyright 2017-present MongoDB, Inc.
* * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at *
< * http://www.apache.org/licenses/LICENSE-2.0
> * https://www.apache.org/licenses/LICENSE-2.0
* * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ namespace MongoDB; use IteratorAggregate;
> use ReturnTypeWillChange;
use stdClass; use Traversable;
>
use function call_user_func; /** * 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. * * @api * @see \MongoDB\Collection::mapReduce()
< * @see https://docs.mongodb.com/manual/reference/command/mapReduce/
> * @see https://mongodb.com/docs/manual/reference/command/mapReduce/
*/ class MapReduceResult implements IteratorAggregate { /** @var callable */ private $getIterator; /** @var integer */ private $executionTimeMS; /** @var array */ private $counts; /** @var array */ private $timing; /** * @internal * @param callable $getIterator Callback that returns a Traversable for mapReduce results * @param stdClass $result Result document from the mapReduce command */ public function __construct(callable $getIterator, stdClass $result) { $this->getIterator = $getIterator;
< $this->executionTimeMS = (integer) $result->timeMillis; < $this->counts = (array) $result->counts;
> $this->executionTimeMS = isset($result->timeMillis) ? (integer) $result->timeMillis : 0; > $this->counts = isset($result->counts) ? (array) $result->counts : [];
$this->timing = isset($result->timing) ? (array) $result->timing : []; } /** * Returns various count statistics from the mapReduce command. * * @return array */ public function getCounts() { return $this->counts; } /** * Return the command execution time in milliseconds. * * @return integer */ public function getExecutionTimeMS() {
< return (integer) $this->executionTimeMS;
> return $this->executionTimeMS;
} /** * Return the mapReduce results as a Traversable. *
< * @see http://php.net/iteratoraggregate.getiterator
> * @see https://php.net/iteratoraggregate.getiterator
* @return Traversable */
> #[ReturnTypeWillChange]
public function getIterator() { return call_user_func($this->getIterator); } /** * 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 */ public function getTiming() { return $this->timing; } }