[Summary view]

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

   1  <?php
   2  /*
   3   * Copyright 2015-present 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   *   https://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 https://mongodb.com/docs/manual/reference/command/listCollections/
  33   */
  34  class CollectionInfoCommandIterator extends IteratorIterator implements CollectionInfoIterator
  35  {
  36      /** @var string|null */
  37      private $databaseName;
  38  
  39      public function __construct(Traversable $iterator, ?string $databaseName = null)
  40      {
  41          parent::__construct($iterator);
  42  
  43          $this->databaseName = $databaseName;
  44      }
  45  
  46      /**
  47       * Return the current element as a CollectionInfo instance.
  48       *
  49       * @see CollectionInfoIterator::current()
  50       * @see https://php.net/iterator.current
  51       */
  52      public function current(): CollectionInfo
  53      {
  54          $info = parent::current();
  55  
  56          if ($this->databaseName !== null && isset($info['idIndex']) && ! isset($info['idIndex']['ns'])) {
  57              $info['idIndex']['ns'] = $this->databaseName . '.' . $info['name'];
  58          }
  59  
  60          return new CollectionInfo($info);
  61      }
  62  }