git.mxchange.org Git - hub.git/blob

   1 <?php
   2 // Own namespace
   3 namespace Hub\Node\Helper\Answer\Request\NodeList;
   4
   5 // Import application-specific stuff
   6 use Hub\Helper\Node\NodeHelper;
   7
   8 /**
   9  * A RequestNodeListMessageAnswer node helper class
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.shipsimu.org
  16  * @todo                Find an interface for hub helper
  17  *
  18  * This program is free software: you can redistribute it and/or modify
  19  * it under the terms of the GNU General Public License as published by
  20  * the Free Software Foundation, either version 3 of the License, or
  21  * (at your option) any later version.
  22  *
  23  * This program is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  * GNU General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU General Public License
  29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  30  */
  31 class NodeRequestNodeListMessageAnswerHelper extends BaseHubAnswerHelper implements HelpableNode {
  32         /**
  33          * Protected constructor
  34          *
  35          * @return      void
  36          */
  37         protected function __construct () {
  38                 // Call parent constructor
  39                 parent::__construct(__CLASS__);
  40
  41                 // Init package tags
  42                 $this->setPackageTags(array('request_node_list_answer'));
  43         }
  44
  45         /**
  46          * Creates the helper class
  47          *
  48          * @param       $messageData            An array with all message data
  49          * @return      $helperInstance         A prepared instance of this helper
  50          */
  51         public final static function createNodeRequestNodeListMessageAnswerHelper (array $messageData) {
  52                 // Get new instance
  53                 $helperInstance = new NodeRequestNodeListMessageAnswerHelper();
  54
  55                 // Set session id of other peer as recipient
  56                 $helperInstance->setRecipientType($messageData[XmlRequestNodeListTemplateEngine::REQUEST_DATA_SESSION_ID]);
  57
  58                 // Set message data
  59                 $helperInstance->setMessageData($messageData);
  60
  61                 // Return the prepared instance
  62                 return $helperInstance;
  63         }
  64
  65         /**
  66          * Loads the descriptor XML file
  67          *
  68          * @param       $nodeInstance   An instance of a NodeHelper class
  69          * @return      void
  70          */
  71         public function loadDescriptorXml (NodeHelper $nodeInstance) {
  72                 // Debug message
  73                 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('HELPER[' . __METHOD__ . ':' . __LINE__ . ']: Attempting to answer a request: node-list...');
  74
  75                 // Get a XML template instance
  76                 $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('node_request_node_list_answer_template_class');
  77
  78                 // Set it for later use
  79                 $this->setTemplateInstance($templateInstance);
  80
  81                 // Read the XML descriptor
  82                 $templateInstance->loadXmlTemplate();
  83
  84                 // "Cache" entries instance for next foreach loop
  85                 $entriesInstance = $templateInstance->getTemplateInstance();
  86
  87                 // Is must not be NULL (then it can only be a template instance)
  88                 assert(!is_null($entriesInstance));
  89
  90                 // Render the XML content
  91                 $templateInstance->renderXmlContent();
  92         }
  93
  94         /**
  95          * Send out request-node-list answer package
  96          *
  97          * @param       $nodeInstance   An instance of a NodeHelper class
  98          * @return      void
  99          */
 100         public function sendPackage (NodeHelper $nodeInstance) {
 101                 // Sanity check: Is the node in the approx. state? (active/reachable)
 102                 $nodeInstance->getStateInstance()->validateNodeStateIsActiveOrReachable();
 103
 104                 // Compile the template, this inserts the loaded node data into the gaps.
 105                 $this->getTemplateInstance()->compileTemplate();
 106
 107                 // Get a singleton network package instance
 108                 $packageInstance = NetworkPackageFactory::createNetworkPackageInstance();
 109
 110                 // Next, feed the content in. The network package class is a pipe-through class.
 111                 $packageInstance->enqueueRawDataFromTemplate($this);
 112         }
 113 }
 114
 115 // [EOF]
 116 ?>