HubConnectionHelper is more a factory than a helper class, HelpableHub interface...

[hub.git] / application / hub / main / factories / socket / class_SocketFactory.php

diff --git a/application/hub/main/factories/socket/class_SocketFactory.php b/application/hub/main/factories/socket/class_SocketFactory.php
new file mode 100644 (file)
index 0000000..42a82da
--- /dev/null
+++ b/application/hub/main/factories/socket/class_SocketFactory.php
@@ -0,0 +1,56 @@
+<?php
+/**
+ * A socket factory class
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.ship-simu.org
+ * @todo               Find an interface for hub helper
+ *
+ * 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 SocketFactory extends BaseHubHelper {
+       /**
+        * Protected constructor
+        *
+        * @return      void
+        */
+       protected function __construct () {
+               // Call parent constructor
+               parent::__construct(__CLASS__);
+       }
+
+       /**
+        * Creates a valid socket resource from given packae data and protocol
+        *
+        * @param       $packageData            Raw package data
+        * @param       $protocolName           Protocol name (TCP/UDP)
+        * @return      $socketResource         Socket resource
+        */
+       public static function createSocketFromPackageData (array $packageData, $protocolName) {
+               // Construct configuration entry for object factory
+               $configEntry = $protocolName . '_connection_class';
+
+               // And call the static method
+               $socketResource = call_user_func(FrameworkConfiguration::getInstance()->getConfigEntry($configEntry) . '::createConnectionFromPackageData', $packageData);
+
+               // Return the resource
+               return $socketResource;
+       }
+}
+
+// [EOF]
+?>