framework/main/classes/lists/class_

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