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

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