framework/main/classes/iterator/class_BaseIterator.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Iterator;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Lists\Listable;
   7 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
   8
   9 // Import SPL stuff
  10 use \Iterator;
  11
  12 /**
  13  * A general iterator
  14  *
  15  * @author              Roland Haeder <webmaster@shipsimu.org>
  16  * @version             0.0.0
  17  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
  18  * @license             GNU GPL 3.0 or any newer version
  19  * @link                http://www.shipsimu.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 abstract class BaseIterator extends BaseFrameworkSystem implements Iterator {
  35         /**
  36          * Instance of the list
  37          */
  38         private $listInstance = NULL;
  39
  40         /**
  41          * Protected constructor
  42          *
  43          * @param       $className      Name of the class
  44          * @return      void
  45          */
  46         protected function __construct (string $className) {
  47                 // Call parent constructor
  48                 parent::__construct($className);
  49         }
  50
  51         /**
  52          * Setter for the list instance
  53          *
  54          * @param       $listInstance   A list of Listable
  55          * @return      void
  56          */
  57         protected final function setListInstance (Listable $listInstance) {
  58                 $this->listInstance = $listInstance;
  59         }
  60
  61         /**
  62          * Getter for the list instance
  63          *
  64          * @return      $listInstance   A list of Listable
  65          */
  66         protected final function getListInstance () {
  67                 return $this->listInstance;
  68         }
  69
  70 }