Added initial crawler stuff:

[hub.git] / application / hub / main / factories / states / communicator / class_CommunicatorStateFactory.php

diff --git a/application/hub/main/factories/states/communicator/class_CommunicatorStateFactory.php b/application/hub/main/factories/states/communicator/class_CommunicatorStateFactory.php
new file mode 100644 (file)
index 0000000..8f5d9b1
--- /dev/null
+++ b/application/hub/main/factories/states/communicator/class_CommunicatorStateFactory.php
@@ -0,0 +1,65 @@
+<?php
+/**
+ * A factory class for communicator states
+ *
+ * @author             Roland Haeder <webmaster@shipsimu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2014 Core Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.shipsimu.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 CommunicatorStateFactory extends ObjectFactory {
+       /**
+        * Protected constructor
+        *
+        * @return      void
+        */
+       protected function __construct () {
+               // Call parent constructor
+               parent::__construct(__CLASS__);
+       }
+
+       /**
+        * Creates an instance of a configurable communicator state and sets it in the
+        * given communicator instance.
+        *
+        * @param       $stateName                              Name of the state
+        * @param       $communicatorInstance   A Communicator class instance
+        * @return      $stateInstance                  A Stateable class instance
+        */
+       public static final function createCommunicatorStateInstanceByName ($stateName, Communicator $communicatorInstance) {
+               // Then construct the class' configuraton entry
+               $className = 'communicator_' . $stateName . '_state_class';
+
+               // Get a class from that configuration entry
+               $stateInstance = self::createObjectByConfiguredName($className, array($communicatorInstance));
+
+               // Debug message
+               self::createDebugInstance(__CLASS__)->debugOutput('COMMUNICATOR-STATE-FACTORY[' . __METHOD__ . ':' . __LINE__ . ']: Communicator state has changed from ' . $communicatorInstance->getPrintableState() . ' to ' . $stateInstance->getStateName() . '.');
+
+               // Once we have that state, set it in the communicator instance
+               $communicatorInstance->setStateInstance($stateInstance);
+
+               // Update communicator data
+               $communicatorInstance->updateCommunicatorData();
+
+               // For any purposes, return the state instance
+               return $stateInstance;
+       }
+}
+
+// [EOF]
+?>