application/hub/main/factories/lists/class_RecipientListFactory.php

   1 <?php
   2 /**
   3  * A factory class for recipient lists
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 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 RecipientListFactory extends ObjectFactory {
  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          * Returns a singleton network package instance. If an instance is found in
  37          * the registry it will be returned, else a new instance is created and
  38          * stored in the same registry entry.
  39          *
  40          * @return      $listInstance   A recipient list instance
  41          */
  42         public static final function createRecipientListInstance () {
  43                 // Do we have an instance in the registry?
  44                 if (Registry::getRegistry()->instanceExists('recipient_list')) {
  45                         // Then use this instance
  46                         $listInstance = Registry::getRegistry()->getInstance('recipient_list');
  47                 } else {
  48                         // Create a new instance
  49                         $listInstance = self::createObjectByConfiguredName('recipient_list_class');
  50
  51                         // Set the instance in registry for further use
  52                         Registry::getRegistry()->addInstance('recipient_list', $listInstance);
  53                 }
  54
  55                 // Return the instance
  56                 return $listInstance;
  57         }
  58 }
  59
  60 // [EOF]
  61 ?>