State pattern added, hub continued (sorry, I let it lay around uncommitted for long...

[hub.git] / application / hub / main / factories / states / class_StateFactory.php

diff --git a/application/hub/main/factories/states/class_StateFactory.php b/application/hub/main/factories/states/class_StateFactory.php
new file mode 100644 (file)
index 0000000..c726543
--- /dev/null
+++ b/application/hub/main/factories/states/class_StateFactory.php
@@ -0,0 +1,57 @@
+<?php
+/**
+ * A factory class for states
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Hub Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.ship-simu.org
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+class StateFactory extends ObjectFactory {
+       /**
+        * Creates an instance of a configurable node state and sets it in the
+        * given node instance.
+        *
+        * @param       $stateName              Name of the state
+        * @param       $nodeInstance   A NodeHelper class instance
+        * @return      $stateInstance  A Stateable class instance
+        */
+       public static final function createStateInstanceByName($stateName, NodeHelper $nodeInstance) {
+               // Then construct the class' configuraton entry
+               $className = 'node_' . $stateName . '_state_class';
+
+               // Get a class from that configuration entry
+               $stateInstance = self::createObjectByConfiguredName($className, array($nodeInstance));
+
+               // Once we have that state, set it in the node instance
+               $nodeInstance->setStateInstance($stateInstance);
+
+               // For any purposes, return the state instance
+               return $stateInstance;
+       }
+
+       /**
+        * Protected constructor
+        *
+        * @return      void
+        */
+       protected function __construct () {
+               // Call parent constructor
+               parent::__construct(__CLASS__);
+       }
+}
+?>