framework/main/classes/lists/groups/class_ListGroupList.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Lists\Group;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Lists\BaseList;
   7 use Org\Mxchange\CoreFramework\Lists\Listable;
   8 use Org\Mxchange\CoreFramework\Middleware\Debug\DebugMiddleware;
   9
  10 /**
  11  * A ListGroup list
  12  *
  13  * @author              Roland Haeder <webmaster@shipsimu.org>
  14  * @version             0.0.0
  15  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
  16  * @license             GNU GPL 3.0 or any newer version
  17  * @link                http://www.shipsimu.org
  18  *
  19  * This program is free software: you can redistribute it and/or modify
  20  * it under the terms of the GNU General Public License as published by
  21  * the Free Software Foundation, either version 3 of the License, or
  22  * (at your option) any later version.
  23  *
  24  * This program is distributed in the hope that it will be useful,
  25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  27  * GNU General Public License for more details.
  28  *
  29  * You should have received a copy of the GNU General Public License
  30  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  31  */
  32 class ListGroupList extends BaseList implements Listable {
  33         /**
  34          * Protected constructor
  35          *
  36          * @return      void
  37          */
  38         private function __construct () {
  39                 // Call parent constructor
  40                 parent::__construct(__CLASS__);
  41         }
  42
  43         /**
  44          * Creates an instance of this class
  45          *
  46          * @return      $listInstance   An instance a Listable class
  47          */
  48         public static final function createListGroupList () {
  49                 // Get new instance
  50                 $listInstance = new ListGroupList();
  51
  52                 // Return the prepared instance
  53                 return $listInstance;
  54         }
  55
  56         /**
  57          * "Getter" for an iterator instance of this list (not implemented)
  58          *
  59          * @return      $iteratorInstance       An instance of a Iterator class
  60          */
  61         public function getListIterator () {
  62                 $this->debugInstance($this->__toString() . ' uses the default iterator. Please call getIterator() instead!');
  63         }
  64
  65         /**
  66          * Clears this list by cleaning up all groups together.
  67          *
  68          * @return      void
  69          * @todo        0% done
  70          */
  71         public function clearList () {
  72                 DebugMiddleware::getSelfInstance()->partialStub('Please implement this method.');
  73         }
  74
  75 }