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 2018 MongoDB, Inc.
> * Copyright 2018-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\Model; use Iterator; use MongoDB\Exception\InvalidArgumentException; use MongoDB\Exception\UnexpectedValueException;
> use ReturnTypeWillChange; use function is_array; >
use function MongoDB\BSON\toPHP; use function sprintf; use function strlen; use function substr; use function unpack; /** * Iterator for BSON documents. */ class BSONIterator implements Iterator { /** @var integer */ private static $bsonSize = 4; /** @var string */ private $buffer; /** @var integer */ private $bufferLength; /** @var mixed */ private $current; /** @var integer */ private $key = 0; /** @var integer */ private $position = 0; /** @var array */ private $options; /** * Constructs a BSON Iterator. * * Supported options: * * * typeMap (array): Type map for BSON deserialization. * * @internal
< * @see http://php.net/manual/en/function.mongodb.bson-tophp.php
> * @see https://php.net/manual/en/function.mongodb.bson-tophp.php
* @param string $data Concatenated, valid, BSON-encoded documents * @param array $options Iterator options * @throws InvalidArgumentException for parameter/option parsing errors */
< public function __construct($data, array $options = [])
> public function __construct(string $data, array $options = [])
{ if (isset($options['typeMap']) && ! is_array($options['typeMap'])) { throw InvalidArgumentException::invalidType('"typeMap" option', $options['typeMap'], 'array'); } if (! isset($options['typeMap'])) { $options['typeMap'] = []; } $this->buffer = $data; $this->bufferLength = strlen($data); $this->options = $options; } /**
< * @see http://php.net/iterator.current
> * @see https://php.net/iterator.current
* @return mixed */
> #[ReturnTypeWillChange]
public function current() { return $this->current; } /**
< * @see http://php.net/iterator.key
> * @see https://php.net/iterator.key
* @return mixed */
> #[ReturnTypeWillChange]
public function key() { return $this->key; } /**
< * @see http://php.net/iterator.next
> * @see https://php.net/iterator.next
* @return void */
> #[ReturnTypeWillChange]
public function next() { $this->key++; $this->current = null; $this->advance(); } /**
< * @see http://php.net/iterator.rewind
> * @see https://php.net/iterator.rewind
* @return void */
> #[ReturnTypeWillChange]
public function rewind() { $this->key = 0; $this->position = 0; $this->current = null; $this->advance(); } /**
< * @see http://php.net/iterator.valid < * @return boolean
> * @see https://php.net/iterator.valid
*/
< public function valid()
> #[ReturnTypeWillChange] > public function valid(): bool
{ return $this->current !== null; }
< private function advance()
> private function advance(): void
{ if ($this->position === $this->bufferLength) { return; }
< if (($this->bufferLength - $this->position) < self::$bsonSize) {
> if ($this->bufferLength - $this->position < self::$bsonSize) {
throw new UnexpectedValueException(sprintf('Expected at least %d bytes; %d remaining', self::$bsonSize, $this->bufferLength - $this->position)); }
< list(,$documentLength) = unpack('V', substr($this->buffer, $this->position, self::$bsonSize));
> [, $documentLength] = unpack('V', substr($this->buffer, $this->position, self::$bsonSize));
< if (($this->bufferLength - $this->position) < $documentLength) {
> if ($this->bufferLength - $this->position < $documentLength) {
throw new UnexpectedValueException(sprintf('Expected %d bytes; %d remaining', $documentLength, $this->bufferLength - $this->position)); } $this->current = toPHP(substr($this->buffer, $this->position, $documentLength), $this->options['typeMap']); $this->position += $documentLength; } }