[Summary view]

Differences Between: [Versions 310 and 401] [Versions 310 and 402] [Versions 310 and 403]

   1  <?php
   2  
   3  // This file is part of Moodle - http://moodle.org/
   4  //
   5  // Moodle is free software: you can redistribute it and/or modify
   6  // it under the terms of the GNU General Public License as published by
   7  // the Free Software Foundation, either version 3 of the License, or
   8  // (at your option) any later version.
   9  //
  10  // Moodle is distributed in the hope that it will be useful,
  11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  // GNU General Public License for more details.
  14  //
  15  // You should have received a copy of the GNU General Public License
  16  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17  
  18  /**
  19   * @package    moodlecore
  20   * @subpackage backup-helper
  21   * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  /**
  26   * Implementation of iterator interface to work without information
  27   *
  28   * This class implementes the iterator but does nothing (as far as it
  29   * doesn't handle real data at all). It's here to provide one common
  30   * API when we want to skip some elements from structure, while also
  31   * working with array/db iterators at the same time.
  32   *
  33   * TODO: Finish phpdocs
  34   */
  35  class backup_null_iterator implements iterator {
  36  
  37      public function rewind() {
  38      }
  39  
  40      public function current() {
  41      }
  42  
  43      public function key() {
  44      }
  45  
  46      public function next() {
  47      }
  48  
  49      public function valid() {
  50          return false;
  51      }
  52  
  53      public function close() { // Added to provide compatibility with recordset iterators
  54      }
  55  }