Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.

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

   1  <?php
   2  /*
   3   * Copyright 2015-2017 MongoDB, Inc.
   4   *
   5   * Licensed under the Apache License, Version 2.0 (the "License");
   6   * you may not use this file except in compliance with the License.
   7   * You may obtain a copy of the License at
   8   *
   9   *   http://www.apache.org/licenses/LICENSE-2.0
  10   *
  11   * Unless required by applicable law or agreed to in writing, software
  12   * distributed under the License is distributed on an "AS IS" BASIS,
  13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14   * See the License for the specific language governing permissions and
  15   * limitations under the License.
  16   */
  17  
  18  namespace MongoDB\Model;
  19  
  20  use IteratorIterator;
  21  use Traversable;
  22  
  23  /**
  24   * CollectionInfoIterator for listCollections command results.
  25   *
  26   * This iterator may be used to wrap a Cursor returned by the listCollections
  27   * command.
  28   *
  29   * @internal
  30   * @see \MongoDB\Database::listCollections()
  31   * @see https://github.com/mongodb/specifications/blob/master/source/enumerate-collections.rst
  32   * @see http://docs.mongodb.org/manual/reference/command/listCollections/
  33   */
  34  class CollectionInfoCommandIterator extends IteratorIterator implements CollectionInfoIterator
  35  {
  36      /** @var string|null */
  37      private $databaseName;
  38  
  39      /**
  40       * @param string|null $databaseName
  41       */
  42      public function __construct(Traversable $iterator, $databaseName = null)
  43      {
  44          parent::__construct($iterator);
  45  
  46          $this->databaseName = $databaseName;
  47      }
  48  
  49      /**
  50       * Return the current element as a CollectionInfo instance.
  51       *
  52       * @see CollectionInfoIterator::current()
  53       * @see http://php.net/iterator.current
  54       * @return CollectionInfo
  55       */
  56      public function current()
  57      {
  58          $info = parent::current();
  59  
  60          if ($this->databaseName !== null && isset($info['idIndex']) && ! isset($info['idIndex']['ns'])) {
  61              $info['idIndex']['ns'] = $this->databaseName . '.' . $info['name'];
  62          }
  63  
  64          return new CollectionInfo($info);
  65      }
  66  }