application/hub/main/factories/communicator/class_CommunicatorFactory.php

   1 <?php
   2 /**
   3  * A factory class for communicator
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2014, 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 CommunicatorFactory 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 communicator instance. If no instance is found, it fill
  37          * be generated and stored in registry, else the communicator from the
  38          * registry will be returned.
  39          *
  40          * @param       $configEntry                    A configuration entry naming the real class' name
  41          * @parasm      $communicatorType               Type of the communicator, can currently be 'node'
  42          * @return      $communicatorInstance   A communicator instance
  43          */
  44         public static final function createCommunicatorInstance ($configEntry, $communicatorType) {
  45                 // If there is no communicator?
  46                 if (Registry::getRegistry()->instanceExists($communicatorType . '_communicator')) {
  47                         // Get communicator from registry
  48                         $communicatorInstance = Registry::getRegistry()->getInstance($communicatorType . '_communicator');
  49                 } else {
  50                         // Get the communicator instance
  51                         $communicatorInstance = self::createObjectByConfiguredName($configEntry);
  52
  53                         // Add it to the registry
  54                         Registry::getRegistry()->addInstance($communicatorType . '_communicator', $communicatorInstance);
  55                 }
  56
  57                 // Return the instance
  58                 return $communicatorInstance;
  59         }
  60 }
  61
  62 // [EOF]
  63 ?>