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