application/hub/classes/discovery/recipient/class_BaseRecipientDiscovery.php

   1 <?php
   2 /**
   3  * A PackageRecipient discovery class
   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 BaseRecipientDiscovery extends BaseNodeDiscovery implements DiscoverableRecipient {
  25         /**
  26          * Protected constructor
  27          *
  28          * @param       $className      Real class name
  29          * @return      void
  30          */
  31         protected function __construct ($className) {
  32                 // Call parent constructor
  33                 parent::__construct($className);
  34
  35                 /*
  36                  * Get recipients list instance and set it here for all discovery
  37                  * implementations.
  38                  */
  39                 $listInstance = RecipientListFactory::createRecipientListInstance();
  40                 $this->setListInstance($listInstance);
  41         }
  42
  43         /**
  44          * "Getter" for recipient iterator
  45          *
  46          * @return$iteratorInstance An instance of a Iterateable object
  47          */
  48         public final function getIterator () {
  49                 // Get iterator from it
  50                 $iteratorInstance = $this->getListInstance()->getIterator();
  51
  52                 // Return it
  53                 return $iteratorInstance;
  54         }
  55
  56         /**
  57          * Clears all recipients for e.g. another package to deliver. This method
  58          * simply clears the inner list instance.
  59          *
  60          * @return      void
  61          */
  62         public final function clearRecipients () {
  63                 // Clear the list
  64                 $this->getListInstance()->clearList();
  65         }
  66
  67         /**
  68          * Checks whether the recipient list is empty
  69          *
  70          * @return      $isEmpty        Whether the recipient list is empty
  71          */
  72         public final function isRecipientListEmpty () {
  73                 // Check it ...
  74                 $isEmpty = ($this->getListInstance()->count() == 0);
  75
  76                 // Return it
  77                 return $isEmpty;
  78         }
  79 }
  80
  81 // [EOF]
  82 ?>