application/hub/main/factories/handler/class_ProtocolHandlerFactory.php

   1 <?php
   2 /**
   3  * A factory class for protocol handlers
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  * @todo                Unfinished stuff
  11  *
  12  * This program is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24  */
  25 class ProtocolHandlerFactory extends ObjectFactory {
  26         /**
  27          * Protected constructor
  28          *
  29          * @return      void
  30          */
  31         protected function __construct () {
  32                 // Call parent constructor
  33                 parent::__construct(__CLASS__);
  34         }
  35
  36         /**
  37          * Returns a singleton protocol handler instance. If an instance is
  38          * found in registry, it will be returned, else a new instance is created
  39          * and stored in the same registry entry.
  40          *
  41          * @param       $messageType            Protocol to create an object from
  42          * @return      $handlerInstance        A protocol handler instance
  43          */
  44         public static final function createProtocolHandlerInstance ($messageType) {
  45                 // Do we have an instance in the registry?
  46                 if (Registry::getRegistry()->instanceExists($messageType . '_protocol_handler')) {
  47                         // Then use this instance
  48                         $handlerInstance = Registry::getRegistry()->getInstance($messageType . '_protocol_handler');
  49                 } else {
  50                         // Now prepare the tags instance
  51                         $handlerInstance = self::createObjectByConfiguredName($messageType . '_protocol_handler_class');
  52
  53                         // Set the instance in registry for further use
  54                         Registry::getRegistry()->addInstance($messageType . '_protocol_handler', $handlerInstance);
  55                 }
  56
  57                 // Return the instance
  58                 return $handlerInstance;
  59         }
  60 }
  61
  62 // [EOF]
  63 ?>