Updated 'core' + renamed 'main' -> 'classes'.

[hub.git] / application / hub / classes / helper / class_

diff --git a/application/hub/classes/helper/class_ b/application/hub/classes/helper/class_
new file mode 100644 (file)
index 0000000..e982dd3
--- /dev/null
+++ b/application/hub/classes/helper/class_
@@ -0,0 +1,86 @@
+<?php
+/**
+ * A ??? !!! helper class
+ *
+ * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub 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 !!!???Helper extends BaseHubSystemHelper implements Helpable!!! {
+       /**
+        * Protected constructor
+        *
+        * @return      void
+        */
+       protected function __construct () {
+               // Call parent constructor
+               parent::__construct(__CLASS__);
+
+               // Set recipient type
+               $this->setRecipientType(NetworkPackage::NETWORK_TARGET_```);
+
+               // Set package tags
+               $this->setPackageTags(array('???'));
+       }
+
+       /**
+        * Creates the helper class
+        *
+        * @return      $helperInstance         A prepared instance of this helper
+        */
+       public final static function create!!!???Helper () {
+               // Get new instance
+               $helperInstance = new !!!???Helper();
+
+               // Return the prepared instance
+               return $helperInstance;
+       }
+
+       /**
+        * Loads the descriptor XML file
+        *
+        * @return      void
+        */
+       public function loadDescriptorXml () {
+               $this->partialStub('Please implement this method.');
+       }
+
+       /**
+        * Do the helped attempt by delivering a package to ourselfs
+        *
+        * @param       $|||Instance    An instance of a !!!Helper class
+        * @return      void
+        */
+       public function sendPackage (!!!Helper $|||Instance) {
+               // Sanity check: Is the ||| in the approx. state? (///)
+               $|||Instance->getStateInstance()->validate!!!StateIs+++();
+
+               // Compile the template, this inserts the loaded ||| data into the gaps.
+               $this->getTemplateInstance()->compileTemplate();
+
+               // Get a singleton network package instance
+               $packageInstance = NetworkPackageFactory::createNetworkPackageInstance();
+
+               // Next, feed the content in. The network package class is a pipe-through class.
+               $packageInstance->enqueueRawDataFromTemplate($this);
+       }
+}
+
+// [EOF]
+?>