application/hub/classes/lists/recipient/class_RecipientList.php

   1 <?php
   2 /**
   3  * A Recipient list
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.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 RecipientList extends BaseList implements Listable, Registerable {
  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 static final function createRecipientList () {
  41                 // Get new instance
  42                 $listInstance = new RecipientList();
  43
  44                 // Add groups:
  45                 // 1.) Universal Node Locators
  46                 $listInstance->addGroup('unl');
  47
  48                 // 2.) Session ids
  49                 $listInstance->addGroup('session_id');
  50
  51                 // Return the prepared instance
  52                 return $listInstance;
  53         }
  54
  55         /**
  56          * "Getter" for an iterator instance of this list (not implemented)
  57          *
  58          * @return      $iteratorInstance       An instance of a Iterator class
  59          */
  60         public function getListIterator () {
  61                 $this->debugInstance($this->__toString() . ' uses the default iterator. Please call getIterator() instead!');
  62         }
  63
  64         /**
  65          * Clears this list by cleaning up all groups together.
  66          *
  67          * @return      void
  68          */
  69         public function clearList () {
  70                 // Clear both groups
  71                 $this->clearGroups(array('unl', 'session_id'));
  72         }
  73 }
  74
  75 // [EOF]
  76 ?>