application/hub/main/helper/hub/announcement/class_HubAnnouncementHelper.php

   1 <?php
   2 /**
   3  * A helper class for announcing this node to other nodes
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.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.ship-simu.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 HubAnnouncementHelper extends BaseHubHelper implements HelpableHub {
  26         /**
  27          * An array with all tags for network packages
  28          */
  29         private $packageTags = array('announcement');
  30
  31         /**
  32          * Protected constructor
  33          *
  34          * @return      void
  35          */
  36         protected function __construct () {
  37                 // Call parent constructor
  38                 parent::__construct(__CLASS__);
  39
  40                 // Set recipient type
  41                 $this->setRecipientType(NetworkPackage::NETWORK_TARGET_UPPER_HUBS);
  42         }
  43
  44         /**
  45          * Creates the helper class
  46          *
  47          * @return      $helperInstance         A prepared instance of this helper
  48          */
  49         public static final function createHubAnnouncementHelper () {
  50                 // Get new instance
  51                 $helperInstance = new HubAnnouncementHelper();
  52
  53                 // Return the prepared instance
  54                 return $helperInstance;
  55         }
  56
  57         /**
  58          * Loads the announcement descriptor for parsing
  59          *
  60          * @return      void
  61          */
  62         public function loadDescriptorXml () {
  63                 // Debug message
  64                 $this->debugOutput('HELPER: Starting with announcement to upper hubs...');
  65
  66                 // Get a XML template instance
  67                 $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('node_announcement_template_class');
  68
  69                 // Set it for later use
  70                 $this->setTemplateInstance($templateInstance);
  71
  72                 // Read the XML descriptor
  73                 $this->getTemplateInstance()->loadAnnouncementTemplate();
  74
  75                 // Render the XML content
  76                 $this->getTemplateInstance()->renderXmlContent();
  77         }
  78
  79         /**
  80          * Publishes the node's descriptor XML to all found upper nodes when the
  81          * node has not yet published it's descriptor to a bootstrap node. This is
  82          * done by getting the raw XML content and inserting all variables into
  83          * the code. After this wents fine, the rendered content got "packaged"
  84          * for network delivery.
  85          *
  86          * @param       $nodeInstance   An instance of a NodeHelper class
  87          * @return      void
  88          */
  89         public function sendPackage (NodeHelper $nodeInstance) {
  90                 // Sanity check: Is the node in the approx. state? (active)
  91                 $nodeInstance->getStateInstance()->validateNodeStateIsActiveOrReachable();
  92
  93                 // Compile the template, this inserts the loaded node data into the gaps.
  94                 $this->getTemplateInstance()->compileTemplate();
  95
  96                 // Get a singleton network package instance
  97                 $packageInstance = NetworkPackageFactory::createNetworkPackageInstance();
  98
  99                 // Next, feed the content in. The network package class is a pipe-through class.
 100                 $packageInstance->enqueueRawDataFromTemplate($this, NetworkPackage::PROTOCOL_TCP);
 101         }
 102
 103         /**
 104          * Getter for package tags in a simple array
 105          *
 106          * @return      $tags   An array with all tags for the currently handled package
 107          */
 108         public final function getPackageTags () {
 109                 return $this->packageTags;
 110         }
 111 }
 112
 113 // [EOF]
 114 ?>