framework/main/interfaces/iterator/registry/class_IteratableRegistry.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Iterator\Registry;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
   7
   8 // Import SPL stuff
   9 use \Iterator;
  10
  11 /**
  12  * A registry iterator interface
  13  *
  14  * @author              Roland Haeder <webmaster@ship-simu.org>
  15  * @version             0.0.0
  16  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2019 Core Developer Team
  17  * @license             GNU GPL 3.0 or any newer version
  18  * @link                http://www.ship-simu.org
  19  *
  20  * This program is free software: you can redistribute it and/or modify
  21  * it under the terms of the GNU General Public License as published by
  22  * the Free Software Foundation, either version 3 of the License, or
  23  * (at your option) any later version.
  24  *
  25  * This program is distributed in the hope that it will be useful,
  26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28  * GNU General Public License for more details.
  29  *
  30  * You should have received a copy of the GNU General Public License
  31  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  32  */
  33 interface IteratableRegistry extends FrameworkInterface, Iterator {
  34
  35         /**
  36          * Initializes this iterator by scanning over the registry for all keys.
  37          *
  38          * @return      void
  39          * @throws      LogicException  If a registry entry does not implement Registerable
  40          * @throws      NullPointerException    If criteriaKey or criteriaMethod is not set but a call-back instance is set
  41          */
  42         function initIterator (FrameworkInterface $callbackInstance = NULL, $criteriaKey = NULL, $criteriaMethod = NULL);
  43
  44 }