application/hub/main/helper/node/announcement/class_NodeAnnouncementHelper.php

   1 <?php
   2 /**
   3  * A helper class for announcing this node to other nodes
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 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 NodeAnnouncementHelper extends BaseNodeHelper 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                 // Set recipient type
  36                 $this->setRecipientType(NetworkPackage::NETWORK_TARGET_UPPER);
  37
  38                 // Set package tags
  39                 $this->setPackageTags(array('announcement'));
  40         }
  41
  42         /**
  43          * Creates the helper class
  44          *
  45          * @return      $helperInstance         A prepared instance of this helper
  46          */
  47         public static final function createNodeAnnouncementHelper () {
  48                 // Get new instance
  49                 $helperInstance = new NodeAnnouncementHelper();
  50
  51                 // Return the prepared instance
  52                 return $helperInstance;
  53         }
  54
  55         /**
  56          * Loads the announcement descriptor for parsing
  57          *
  58          * @param       $nodeInstance   An instance of a NodeHelper class
  59          * @return      void
  60          */
  61         public function loadDescriptorXml (NodeHelper $nodeInstance) {
  62                 // Debug message
  63                 self::createDebugInstance(__CLASS__)->debugOutput('HELPER[' . __METHOD__ . ':' . __LINE__ . ']: Starting with announcement to upper hubs...');
  64
  65                 // Get a XML template instance
  66                 $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('node_announcement_template_class');
  67
  68                 // Set it for later use
  69                 $this->setTemplateInstance($templateInstance);
  70
  71                 // Read the XML descriptor
  72                 $templateInstance->loadXmlTemplate();
  73
  74                 // Render the XML content
  75                 $templateInstance->renderXmlContent();
  76         }
  77
  78         /**
  79          * Publishes the node's descriptor XML to all found upper nodes when the
  80          * node has not yet published it's descriptor to a bootstrap node. This is
  81          * done by getting the raw XML content and inserting all variables into
  82          * the code. After this wents fine, the rendered content got "packaged"
  83          * for network delivery.
  84          *
  85          * @param       $nodeInstance   An instance of a NodeHelper class
  86          * @return      void
  87          */
  88         public function sendPackage (NodeHelper $nodeInstance) {
  89                 // Sanity check: Is the node in the approx. state? (active)
  90                 $nodeInstance->getStateInstance()->validateNodeStateIsActiveOrReachable();
  91
  92                 // Compile the template, this inserts the loaded node data into the gaps.
  93                 $this->getTemplateInstance()->compileTemplate();
  94
  95                 // Get a singleton network package instance
  96                 $packageInstance = NetworkPackageFactory::createNetworkPackageInstance();
  97
  98                 // Next, feed the content in. The network package class is a pipe-through class.
  99                 $packageInstance->enqueueRawDataFromTemplate($this);
 100         }
 101 }
 102
 103 // [EOF]
 104 ?>