framework/main/traits/iterator/class_IteratorTrait.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Traits\Iterator;
   4
   5 // Import SPL stuff
   6 use \Iterator;
   7
   8 /**
   9  * A trait for iterators
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.shipsimu.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 trait IteratorTrait {
  31         /**
  32          * Instance of an Iterator class
  33          */
  34         private $iteratorInstance = NULL;
  35
  36         /**
  37          * Setter for Iterator instance
  38          *
  39          * @param       $iteratorInstance       An instance of an Iterator
  40          * @return      void
  41          */
  42         protected final function setIteratorInstance (Iterator $iteratorInstance) {
  43                 $this->iteratorInstance = $iteratorInstance;
  44         }
  45
  46         /**
  47          * Getter for Iterator instance
  48          *
  49          * @return      $iteratorInstance       An instance of an Iterator
  50          */
  51         public final function getIteratorInstance () {
  52                 return $this->iteratorInstance;
  53         }
  54
  55 }