framework/main/classes/iterator/class_

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