3 * A factory class for ??? states
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 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 NodeStateFactory extends ObjectFactory {
26 * Creates an instance of a configurable node state and sets it in the
27 * given node instance.
29 * @param $stateName Name of the node state
30 * @param $nodeInstance A NodeHelper class instance
31 * @return $stateInstance A Stateable class instance
33 public static final function createNodeStateInstanceByName($stateName, NodeHelper $nodeInstance) {
34 // Then construct the class' configuraton entry
35 $className = 'node_' . $stateName . '_state_class';
37 // Get a class from that configuration entry
38 $stateInstance = self::createObjectByConfiguredName($className, array($nodeInstance));
40 // Once we have that state, set it in the node instance
41 $nodeInstance->setNodeStateInstance($stateInstance);
43 // For any purposes, return the state instance
44 return $stateInstance;
48 * Protected constructor
52 protected function __construct () {
53 // Call parent constructor
54 parent::__construct(__CLASS__);