inc/main/classes/lists/tasks/class_TaskList.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\List\Task;
   4
   5 /**
   6  * A Task list
   7  *
   8  * @author              Roland Haeder <webmaster@shipsimu.org>
   9  * @version             0.0.0
  10  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  11  * @license             GNU GPL 3.0 or any newer version
  12  * @link                http://www.shipsimu.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 TaskList extends BaseList implements Listable {
  28         /**
  29          * Protected constructor
  30          *
  31          * @return      void
  32          */
  33         protected 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 static final function createTaskList () {
  44                 // Get new instance
  45                 $listInstance = new TaskList();
  46
  47                 // Add tasks group
  48                 $listInstance->addGroup('tasks');
  49
  50                 // Return the prepared instance
  51                 return $listInstance;
  52         }
  53
  54         /**
  55          * "Getter" for an iterator instance of this list (not implemented)
  56          *
  57          * @return      $iteratorInstance       An instance of a Iterator class
  58          */
  59         public function getListIterator () {
  60                 $this->debugInstance($this->__toString() . ' uses the default iterator. Please call getIterator() instead!');
  61         }
  62
  63         /**
  64          * Clears this list by cleaning up all groups together.
  65          *
  66          * @return      void
  67          */
  68         public function clearList () {
  69                 // Clear the only one group
  70                 $this->clearGroup('tasks');
  71         }
  72
  73 }