includes/utils/iterators/IteratorDecorator.php

   1 <?php
   2 /**
   3  * Allows extending classes to decorate an Iterator with
   4  * reduced boilerplate.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @file
  22  * @ingroup Maintenance
  23  */
  24 abstract class IteratorDecorator implements Iterator {
  25         protected $iterator;
  26
  27         public function __construct( Iterator $iterator ) {
  28                 $this->iterator = $iterator;
  29         }
  30
  31         public function current() {
  32                 return $this->iterator->current();
  33         }
  34
  35         public function key() {
  36                 return $this->iterator->key();
  37         }
  38
  39         public function next() {
  40                 $this->iterator->next();
  41         }
  42
  43         public function rewind() {
  44                 $this->iterator->rewind();
  45         }
  46
  47         public function valid() {
  48                 return $this->iterator->valid();
  49         }
  50 }