3 * A factory class for protocol handlers
5 * @author Roland Haeder <webmaster@shipsimu.org>
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
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.
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.
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/>.
25 class ProtocolHandlerFactory extends ObjectFactory {
27 * Protected constructor
31 protected function __construct () {
32 // Call parent constructor
33 parent::__construct(__CLASS__);
37 * Returns a protocol handler based on given protocol type. This is mostly 'tcp'.
39 * @param $protocolType Protocol type to create/return a protocol handler instance for
40 * @return $handlerInstance A protocol handler instance
42 private static function createProtocolHandlerByType ($protocolType) {
43 // Do we have an instance in the registry?
44 if (Registry::getRegistry()->instanceExists($protocolType . '_protocol_handler')) {
45 // Then use this instance
46 $handlerInstance = Registry::getRegistry()->getInstance($protocolType . '_protocol_handler');
48 // Now prepare the tags instance
49 $handlerInstance = self::createObjectByConfiguredName($protocolType . '_protocol_handler_class');
51 // Set the instance in registry for further use
52 Registry::getRegistry()->addInstance($protocolType . '_protocol_handler', $handlerInstance);
55 // Return the instance
56 return $handlerInstance;
60 * Returns a singleton protocol handler instance from given HubHelper
61 * instance. If an instance is found in registry, it will be returned, else
62 * a new instance is created and stored in the same registry entry.
64 * @param $helperInstance An instance of a HubHelper class
65 * @return $handlerInstance A protocol handler instance
67 public static final function createProtocolHandlerFromRecipientHelper (HubHelper $helperInstance) {
68 // Get the protocol type from given helper instance
69 $protocolType = $helperInstance->determineProtocolType();
71 // Call super factory method
72 return self::createProtocolHandlerByType($protocolType);
76 * Creates an instance of a protocol handler from given (raw) package data
78 * @param $packageData An array with raw package data
79 * @return $handlerInstance A protocol handler instance
81 public static final function createProtocolHandlerFromPackageData (array $packageData) {
82 // "Discover" the protocol type
83 $protocolType = ProtocolDiscovery::discoverProtocolByPackageData($packageData);
85 // Call super factory method
86 return self::createProtocolHandlerByType($protocolType);