3 * A ??? hub helper class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core 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 NodeRequestNodeListHelper extends BaseHubHelper implements HelpableHub {
27 * Protected constructor
31 protected function __construct () {
32 // Call parent constructor
33 parent::__construct(__CLASS__);
36 $this->setRecipientType(NetworkPackage::NETWORK_TARGET_UPPER_NODES);
40 * Creates the helper class
42 * @return $helperInstance A prepared instance of this helper
44 public final static function createNodeRequestNodeListHelper () {
46 $helperInstance = new NodeRequestNodeListHelper();
48 // Return the prepared instance
49 return $helperInstance;
53 * Loads the descriptor XML file
57 public function loadDescriptorXml () {
59 self::createDebugInstance(__CLASS__)->debugOutput('HELPER: Attempting to request node list...');
61 // Get a XML template instance
62 $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('node_request_node_list_template_class');
64 // Set it for later use
65 $this->setTemplateInstance($templateInstance);
67 // Read the XML descriptor
68 $this->getTemplateInstance()->loadRequestNodeListTemplate();
70 // Render the XML content
71 $this->getTemplateInstance()->renderXmlContent();
75 * Do the helped attempt by delivering a package to ourselfs
77 * @param $nodeInstance An instance of a NodeHelper class
80 public function sendPackage (NodeHelper $nodeInstance) {
81 // Sanity check: Is the node in the approx. state? (active)
82 $nodeInstance->getStateInstance()->validateNodeStateIsActive();
84 // Compile the template, this inserts the loaded node data into the gaps.
85 $this->getTemplateInstance()->compileTemplate();
87 // Get a singleton network package instance
88 $packageInstance = NetworkPackageFactory::createNetworkPackageInstance();
90 // Next, feed the content in. The network package class is a pipe-through class.
91 $packageInstance->enqueueRawDataFromTemplate($this);