3 * A factory class for nodes
5 * @author Roland Haeder <webmaster@ship-simu.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.ship-simu.org
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.
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.
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/>.
24 class NodeObjectFactory extends ObjectFactory {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Returns a singleton (registry-based) NodeHelper instance
38 * @param $requestInstance An instance of a class with an Requestable interface
39 * @param $responseInstance An instance of a class with an Responseable interface
40 * @return $nodeInstance An instance of a NodeHelper class
41 * @throws FactoryRequiredParameterException If not all parameters are set and no instance 'node' is set.
43 public static final function createNodeInstance (Requestable $requestInstance = NULL, Responseable $responseInstance = NULL) {
44 // Get new factory instance
45 $factoryInstance = new NodeObjectFactory();
47 // If there is no handler?
48 if (Registry::getRegistry()->instanceExists('node')) {
49 // Get handler from registry
50 $nodeInstance = Registry::getRegistry()->getInstance('node');
51 } elseif (($requestInstance instanceof Requestable) && ($responseInstance instanceof Responseable)) {
52 // The default node-mode is from our configuration
53 $nodeMode = $factoryInstance->getConfigInstance()->getConfigEntry('node_default_mode');
55 // Is the node 'mode' parameter set?
56 if ($requestInstance->isRequestElementSet('mode')) {
57 // Then use this which overrides the config entry temporarily
58 $nodeMode = $requestInstance->getRequestElement('mode');
60 // Set it for easier re-usage
61 $requestInstance->setRequestElement('mode', $nodeMode);
64 // Now convert the node-mode in a class name
65 $className = 'Hub' . $factoryInstance->convertToClassName($nodeMode) . 'Node';
67 // Get the node instance
68 $nodeInstance = ObjectFactory::createObjectByName($className, array($requestInstance));
71 $applicationInstance = Registry::getRegistry()->getInstance('app');
73 // Set the app instance
74 $nodeInstance->setApplicationInstance($applicationInstance);
76 // Add node-specific filters
77 $nodeInstance->addExtraFilters($applicationInstance->getControllerInstance(), $responseInstance);
79 // Add it to the registry
80 Registry::getRegistry()->addInstance('node', $nodeInstance);
82 // Throw an exception here
83 throw new FactoryRequiredParameterException($factoryInstance, self::EXCEPTION_FACTORY_REQUIRE_PARAMETER);
86 // Return the instance