3 * A Descriptor hub helper class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
10 * @todo Find an interface for hub helper
12 * This program is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation, either version 3 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 class HubDescriptorHelper extends BaseHubHelper implements HelpableHub {
27 * An array with all tags for network packages
29 private $packageTags = array('announcement');
32 * Protected constructor
36 protected function __construct () {
37 // Call parent constructor
38 parent::__construct(__CLASS__);
42 * Creates the helper class
44 * @param $nodeInstance An instance of a NodeHelper class
45 * @return $helperInstance A prepared instance of this helper
47 public final static function createHubDescriptorHelper (NodeHelper $nodeInstance) {
49 $helperInstance = new HubDescriptorHelper();
51 // Set the node instance
52 $helperInstance->setNodeInstance($nodeInstance);
54 // Return the prepared instance
55 return $helperInstance;
59 * Loads the announcement descriptor for parsing
62 * @todo Rewrite the ->renderXmlContent() call to no arguments
64 public function loadDescriptorXml () {
66 $this->debugOutput('HELPER: Starting with announcement to upper hubs...');
68 // Get the application instance
69 $appInstance = Registry::getRegistry()->getInstance('app');
71 // Get a XML template instance
72 $templateInstance = ObjectFactory::createObjectByConfiguredName('announcement_template_class', array($appInstance));
74 // Disable language support
75 $templateInstance->enableLanguageSupport(false);
78 * Enable compacting/rewriting of the XML to save bandwidth from XML
79 * comments. This is expensive and should be avoided in general.
81 $templateInstance->enableXmlCompacting();
83 // Set it for later use
84 $this->setTemplateInstance($templateInstance);
86 // Read the XML descriptor
87 $this->getTemplateInstance()->loadAnnouncementTemplate('self_announcement');
89 // Render the XML content
90 $this->getTemplateInstance()->renderXmlContent();
94 * Publishes the node's descriptor XML to all found upper nodes when the
95 * node has not yet published it's descriptor to a bootstrap node. This is
96 * done by getting the raw XML content and inserting all variables into
97 * the code. After this wents fine, the rendered content got "packaged"
98 * for network delivery.
102 public function sendPackage () {
103 // Sanity check: Is the node in the approx. state? (active)
104 $this->getNodeInstance()->getStateInstance()->validateNodeStateIsActive();
106 // Compile the template, this inserts the loaded node data into the gaps.
107 $this->getTemplateInstance()->compileTemplate();
109 // Get a singleton network package instance
110 $packageInstance = NetworkPackageFactory::createNetworkPackageInstance();
112 // Next, feed the content in. The network package class is a pipe-through class.
113 $packageInstance->enqueueRawDataFromTemplate($this);
117 * Getter for package tags in a simple array
119 * @return $tags An array with all tags for the currently handled package
121 public final function getPackageTags () {
122 return $this->packageTags;