application/hub/main/helper/node/answer/requests/class_NodeRequestNodeListMessageAnswerHelper.php

   1 <?php
   2 /**
   3  * A RequestNodeListMessageAnswer node helper class
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  * @todo                Find an interface for hub helper
  11  *
  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.
  16  *
  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.
  21  *
  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/>.
  24  */
  25 class NodeRequestNodeListMessageAnswerHelper extends BaseHubAnswerHelper implements HelpableNode {
  26         /**
  27          * Protected constructor
  28          *
  29          * @return      void
  30          */
  31         protected function __construct () {
  32                 // Call parent constructor
  33                 parent::__construct(__CLASS__);
  34
  35                 // Init package tags
  36                 $this->setPackageTags(array('request_node_list_answer'));
  37         }
  38
  39         /**
  40          * Creates the helper class
  41          *
  42          * @param       $messageData            An array with all message data
  43          * @return      $helperInstance         A prepared instance of this helper
  44          */
  45         public final static function createNodeRequestNodeListMessageAnswerHelper (array $messageData) {
  46                 // Get new instance
  47                 $helperInstance = new NodeRequestNodeListMessageAnswerHelper();
  48
  49                 // Set session id of other peer as recipient
  50                 $helperInstance->setRecipientType($messageData[XmlRequestNodeListTemplateEngine::REQUEST_DATA_SESSION_ID]);
  51
  52                 // Set message data
  53                 $helperInstance->setMessageData($messageData);
  54
  55                 // Return the prepared instance
  56                 return $helperInstance;
  57         }
  58
  59         /**
  60          * Loads the descriptor XML file
  61          *
  62          * @param       $nodeInstance   An instance of a NodeHelper class
  63          * @return      void
  64          */
  65         public function loadDescriptorXml (NodeHelper $nodeInstance) {
  66                 // Debug message
  67                 self::createDebugInstance(__CLASS__)->debugOutput('HELPER[' . __METHOD__ . ':' . __LINE__ . ']: Attempting to answer a request: node-list...');
  68
  69                 // Get a XML template instance
  70                 $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('node_request_node_list_answer_template_class');
  71
  72                 // Set it for later use
  73                 $this->setTemplateInstance($templateInstance);
  74
  75                 // Read the XML descriptor
  76                 $templateInstance->loadXmlTemplate();
  77
  78                 // "Cache" entries instance for next foreach loop
  79                 $entriesInstance = $templateInstance->getTemplateInstance();
  80
  81                 // Is must not be NULL (then it can only be a template instance)
  82                 assert(!is_null($entriesInstance));
  83
  84                 // Render the XML content
  85                 $templateInstance->renderXmlContent();
  86         }
  87
  88         /**
  89          * Send out request-node-list answer package
  90          *
  91          * @param       $nodeInstance   An instance of a NodeHelper class
  92          * @return      void
  93          */
  94         public function sendPackage (NodeHelper $nodeInstance) {
  95                 // Sanity check: Is the node in the approx. state? (active/reachable)
  96                 $nodeInstance->getStateInstance()->validateNodeStateIsActiveOrReachable();
  97
  98                 // Compile the template, this inserts the loaded node data into the gaps.
  99                 $this->getTemplateInstance()->compileTemplate();
 100
 101                 // Get a singleton network package instance
 102                 $packageInstance = NetworkPackageFactory::createNetworkPackageInstance();
 103
 104                 // Next, feed the content in. The network package class is a pipe-through class.
 105                 $packageInstance->enqueueRawDataFromTemplate($this);
 106         }
 107 }
 108
 109 // [EOF]
 110 ?>