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