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

   1 <?php
   2 /**
   3  * A factory class for message type handlers
   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 MessageTypeHandlerFactory 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 message type handler instance. If an instance is
  37          * found in registry, it will be returned, else a new instance is created
  38          * and stored in the same registry entry.
  39          *
  40          * @param       $messageType            Message type to create an object from
  41          * @return      $handlerInstance        A message type handler instance
  42          */
  43         public static final function createMessageTypeHandlerInstance ($messageType) {
  44                 // Do we have an instance in the registry?
  45                 if (Registry::getRegistry()->instanceExists('message_type_' . $messageType . '_handler')) {
  46                         // Then use this instance
  47                         $handlerInstance = Registry::getRegistry()->getInstance('message_type_' . $messageType . '_handler');
  48                 } else {
  49                         // Now prepare the tags instance
  50                         $handlerInstance = self::createObjectByConfiguredName('message_type_' . $messageType . '_handler_class');
  51
  52                         // Set the instance in registry for further use
  53                         Registry::getRegistry()->addInstance('message_type_' . $messageType . '_handler', $handlerInstance);
  54                 }
  55
  56                 // Return the instance
  57                 return $handlerInstance;
  58         }
  59 }
  60
  61 // [EOF]
  62 ?>