framework/main/classes/lists/class_

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