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