[Summary view]

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

   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  
  22  /**
  23   * IndexInfoIterator for both listIndexes command and legacy query results.
  24   *
  25   * This common iterator may be used to wrap a Cursor returned by both the
  26   * listIndexes command and, for legacy servers, queries on the "system.indexes"
  27   * collection.
  28   *
  29   * @internal
  30   * @see \MongoDB\Collection::listIndexes()
  31   * @see https://github.com/mongodb/specifications/blob/master/source/enumerate-indexes.rst
  32   * @see http://docs.mongodb.org/manual/reference/command/listIndexes/
  33   * @see http://docs.mongodb.org/manual/reference/system-collections/
  34   */
  35  class IndexInfoIteratorIterator extends IteratorIterator implements IndexInfoIterator
  36  {
  37      /**
  38       * Return the current element as an IndexInfo instance.
  39       *
  40       * @see IndexInfoIterator::current()
  41       * @see http://php.net/iterator.current
  42       * @return IndexInfo
  43       */
  44      public function current()
  45      {
  46          return new IndexInfo(parent::current());
  47      }
  48  }