framework/main/classes/iterator/class_

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Iterator\!!!;
   4
   5 // Import framework stuff
   6 use CoreFramework\Iterator\BaseIterator;
   7
   8 /**
   9  * A ??? iterator
  10  *
  11  * @author              Roland Haeder <webmaster@ship-simu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.ship-simu.org
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  29  */
  30 class ???Iterator extends BaseIterator implements Iterator {
  31         /**
  32          * Protected constructor
  33          *
  34          * @return      void
  35          */
  36         protected function __construct () {
  37                 // Call parent constructor
  38                 parent::__construct(__CLASS__);
  39         }
  40
  41         /**
  42          * Creates an instance of this class
  43          *
  44          * @return      $iteratorInstance       An instance of a Iterator class
  45          */
  46         public final static function create???Iterator () {
  47                 // Get new instance
  48                 $iteratorInstance = new ???Iterator();
  49
  50                 // Return the prepared instance
  51                 return $iteratorInstance;
  52         }
  53
  54         /**
  55          * Getter for current value from group or generic
  56          *
  57          * @return      $current        Current value in iteration
  58          */
  59         public function current () {
  60                 // Default is null
  61                 $current = null;
  62
  63                 $this->partialStub('Please implement this method.');
  64
  65                 // Return it
  66                 return $current;
  67         }
  68
  69         /**
  70          * Getter for key from group or generic
  71          *
  72          * @return      $key    Current key in iteration
  73          */
  74         public function key () {
  75                 // Default is null
  76                 $key = null;
  77
  78                 $this->partialStub('Please implement this method.');
  79
  80                 // Return it
  81                 return $key;
  82         }
  83
  84         /**
  85          * Advances to the next entry
  86          *
  87          * @return      void
  88          */
  89         public function next () {
  90                 $this->partialStub('Please implement this method.');
  91         }
  92
  93         /**
  94          * Rewinds to the beginning of the iteration
  95          *
  96          * @return      void
  97          */
  98         public function rewind () {
  99                 $this->partialStub('Please implement this method.');
 100         }
 101
 102         /**
 103          * Checks wether the current entry is valid (not at the end of the list)
 104          *
 105          * @return      void
 106          */
 107         public function valid () {
 108                 $this->partialStub('Please implement this method.');
 109         }
 110
 111 }