application/hub/main/helper/connection/udp/class_UdpConnectionHelper.php svneol=native#text/plain
application/hub/main/helper/hub/.htaccess -text svneol=unset#text/plain
application/hub/main/helper/hub/announcement/.htaccess -text svneol=unset#text/plain
+application/hub/main/helper/hub/announcement/class_HubAnnouncementHelper.php svneol=native#text/plain
application/hub/main/helper/hub/announcement/class_HubDescriptorHelper.php svneol=native#text/plain
application/hub/main/helper/hub/class_ svneol=native#text/plain
application/hub/main/helper/hub/class_BaseHubHelper.php svneol=native#text/plain
$cfg->setConfigEntry('list_group_class', 'ListGroupList');
// CFG: HUB-ANNOUNCEMENT-HELPER-CLASS
-$cfg->setConfigEntry('hub_announcement_helper_class', 'HubDescriptorHelper');
+$cfg->setConfigEntry('hub_announcement_helper_class', 'HubAnnouncementHelper');
// CFG: HUB-SELF-CONNECT-HELPER-CLASS
$cfg->setConfigEntry('hub_self_connect_helper_class', 'HubSelfConnectHelper');
interface Deliverable extends FrameworkInterface {
/**
* "Enqueues" raw content into this delivery class by reading the raw content
- * from given template instance and pushing it on the 'undeclared' stack.
+ * from given helper's template instance and pushing it on the 'undeclared'
+ * stack.
*
* @param $helperInstance An instance of a HelpableHub class
* @return void
--- /dev/null
+<?php
+/**
+ * A helper class for announcing this node to other nodes
+ *
+ * @author Roland Haeder <webmaster@ship-simu.org>
+ * @version 0.0.0
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 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 HubAnnouncementHelper extends BaseHubHelper implements HelpableHub {
+ /**
+ * An array with all tags for network packages
+ */
+ private $packageTags = array('announcement');
+
+ /**
+ * Protected constructor
+ *
+ * @return void
+ */
+ protected function __construct () {
+ // Call parent constructor
+ parent::__construct(__CLASS__);
+
+ // Set recipient type
+ $this->setRecipientType(NetworkPackage::NETWORK_TARGET_UPPER_HUBS);
+ }
+
+ /**
+ * Creates the helper class
+ *
+ * @return $helperInstance A prepared instance of this helper
+ */
+ public static final function createHubAnnouncementHelper () {
+ // Get new instance
+ $helperInstance = new HubAnnouncementHelper();
+
+ // Return the prepared instance
+ return $helperInstance;
+ }
+
+ /**
+ * Loads the announcement descriptor for parsing
+ *
+ * @return void
+ */
+ public function loadDescriptorXml () {
+ // Debug message
+ $this->debugOutput('HELPER: Starting with announcement to upper hubs...');
+
+ // Get a XML template instance
+ $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('node_announcement_template_class');
+
+ // Set it for later use
+ $this->setTemplateInstance($templateInstance);
+
+ // Read the XML descriptor
+ $this->getTemplateInstance()->loadAnnouncementTemplate();
+
+ // Render the XML content
+ $this->getTemplateInstance()->renderXmlContent();
+ }
+
+ /**
+ * Publishes the node's descriptor XML to all found upper nodes when the
+ * node has not yet published it's descriptor to a bootstrap node. This is
+ * done by getting the raw XML content and inserting all variables into
+ * the code. After this wents fine, the rendered content got "packaged"
+ * for network delivery.
+ *
+ * @param $nodeInstance An instance of a NodeHelper class
+ * @return void
+ */
+ public function sendPackage (NodeHelper $nodeInstance) {
+ // Sanity check: Is the node in the approx. state? (active)
+ $nodeInstance->getStateInstance()->validateNodeStateIsActive();
+
+ // Compile the template, this inserts the loaded node 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);
+ }
+
+ /**
+ * Getter for package tags in a simple array
+ *
+ * @return $tags An array with all tags for the currently handled package
+ */
+ public final function getPackageTags () {
+ return $this->packageTags;
+ }
+}
+
+// [EOF]
+?>
<?php
-/**
- * A Descriptor hub helper class
- *
- * @author Roland Haeder <webmaster@ship-simu.org>
- * @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 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 HubDescriptorHelper extends BaseHubHelper implements HelpableHub {
- /**
- * An array with all tags for network packages
- */
- private $packageTags = array('announcement');
-
- /**
- * Protected constructor
- *
- * @return void
- */
- protected function __construct () {
- // Call parent constructor
- parent::__construct(__CLASS__);
-
- // Set recipient type
- $this->setRecipientType(NetworkPackage::NETWORK_TARGET_UPPER_HUBS);
- }
-
- /**
- * Creates the helper class
- *
- * @return $helperInstance A prepared instance of this helper
- */
- public static final function createHubDescriptorHelper () {
- // Get new instance
- $helperInstance = new HubDescriptorHelper();
-
- // Return the prepared instance
- return $helperInstance;
- }
-
- /**
- * Loads the announcement descriptor for parsing
- *
- * @return void
- * @todo Rewrite the ->renderXmlContent() call to no arguments
- */
- public function loadDescriptorXml () {
- // Debug message
- $this->debugOutput('HELPER: Starting with announcement to upper hubs...');
-
- // Get a XML template instance
- $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('node_announcement_template_class');
-
- // Set it for later use
- $this->setTemplateInstance($templateInstance);
-
- // Read the XML descriptor
- $this->getTemplateInstance()->loadAnnouncementTemplate();
-
- // Render the XML content
- $this->getTemplateInstance()->renderXmlContent();
- }
-
- /**
- * Publishes the node's descriptor XML to all found upper nodes when the
- * node has not yet published it's descriptor to a bootstrap node. This is
- * done by getting the raw XML content and inserting all variables into
- * the code. After this wents fine, the rendered content got "packaged"
- * for network delivery.
- *
- * @param $nodeInstance An instance of a NodeHelper class
- * @return void
- */
- public function sendPackage (NodeHelper $nodeInstance) {
- // Sanity check: Is the node in the approx. state? (active)
- $nodeInstance->getStateInstance()->validateNodeStateIsActive();
-
- // Compile the template, this inserts the loaded node 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);
- }
-
- /**
- * Getter for package tags in a simple array
- *
- * @return $tags An array with all tags for the currently handled package
- */
- public final function getPackageTags () {
- return $this->packageTags;
- }
-}
-
-// [EOF]
+// @DEPRECATED
?>
/**
* "Enqueues" raw content into this delivery class by reading the raw content
- * from given template instance and pushing it on the 'undeclared' stack.
+ * from given helper's template instance and pushing it on the 'undeclared'
+ * stack.
*
* @param $helperInstance An instance of a HelpableHub class
* @return void
return;
} // END - if
- // Now we know for sure there are packages to deliver, we can start
- // with the first one.
+ /*
+ * Now there are for sure packages to deliver, so start with the first
+ * one.
+ */
$packageData = $this->getStackerInstance()->getNamed(self::STACKER_NAME_UNDECLARED);
// Declare the raw package data for delivery
}
/**
- * Loads the XML file (our "object registry") and saves an instance for faster re-use
+ * Loads the XML file (our "object registry") and saves an instance for
+ * faster re-use.
*
* @return void
*/
projects / hub.git / commitdiff