3 * A Descriptor hub helper class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 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__);
41 $this->setRecipientType(NetworkPackage::NETWORK_TARGET_UPPER_HUBS);
45 * Creates the helper class
47 * @return $helperInstance A prepared instance of this helper
49 public static final function createHubDescriptorHelper () {
51 $helperInstance = new HubDescriptorHelper();
53 // Return the prepared instance
54 return $helperInstance;
58 * Loads the announcement descriptor for parsing
61 * @todo Rewrite the ->renderXmlContent() call to no arguments
63 public function loadDescriptorXml () {
65 $this->debugOutput('HELPER: Starting with announcement to upper hubs...');
67 // Get a XML template instance
68 $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('node_announcement_template_class');
70 // Set it for later use
71 $this->setTemplateInstance($templateInstance);
73 // Read the XML descriptor
74 $this->getTemplateInstance()->loadAnnouncementTemplate();
76 // Render the XML content
77 $this->getTemplateInstance()->renderXmlContent();
81 * Publishes the node's descriptor XML to all found upper nodes when the
82 * node has not yet published it's descriptor to a bootstrap node. This is
83 * done by getting the raw XML content and inserting all variables into
84 * the code. After this wents fine, the rendered content got "packaged"
85 * for network delivery.
87 * @param $nodeInstance An instance of a NodeHelper class
90 public function sendPackage (NodeHelper $nodeInstance) {
91 // Sanity check: Is the node in the approx. state? (active)
92 $nodeInstance->getStateInstance()->validateNodeStateIsActive();
94 // Compile the template, this inserts the loaded node data into the gaps.
95 $this->getTemplateInstance()->compileTemplate();
97 // Get a singleton network package instance
98 $packageInstance = NetworkPackageFactory::createNetworkPackageInstance();
100 // Next, feed the content in. The network package class is a pipe-through class.
101 $packageInstance->enqueueRawDataFromTemplate($this, $nodeInstance);
105 * Getter for package tags in a simple array
107 * @return $tags An array with all tags for the currently handled package
109 public final function getPackageTags () {
110 return $this->packageTags;