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

   1 <?php
   2 /**
   3  * A Descriptor hub helper class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 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 HubDescriptorHelper 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          * @param       $nodeInstance           An instance of a NodeHelper class
  48          * @return      $helperInstance         A prepared instance of this helper
  49          */
  50         public static final function createHubDescriptorHelper (NodeHelper $nodeInstance) {
  51                 // Get new instance
  52                 $helperInstance = new HubDescriptorHelper();
  53
  54                 // Set the node instance
  55                 $helperInstance->setNodeInstance($nodeInstance);
  56
  57                 // Return the prepared instance
  58                 return $helperInstance;
  59         }
  60
  61         /**
  62          * Loads the announcement descriptor for parsing
  63          *
  64          * @return      void
  65          * @todo        Rewrite the ->renderXmlContent() call to no arguments
  66          */
  67         public function loadDescriptorXml () {
  68                 // Debug message
  69                 $this->debugOutput('HELPER: Starting with announcement to upper hubs...');
  70
  71                 // Get the application instance
  72                 $applicationInstance = Registry::getRegistry()->getInstance('app');
  73
  74                 // Get a XML template instance
  75                 $templateInstance = ObjectFactory::createObjectByConfiguredName('node_announcement_template_class');
  76
  77                 // Disable language support
  78                 $templateInstance->enableLanguageSupport(false);
  79
  80                 /*
  81                  * Enable compacting/rewriting of the  XML to save bandwidth from XML
  82                  * comments. This is expensive and should be avoided in general.
  83                  */
  84                 $templateInstance->enableXmlCompacting();
  85
  86                 // Set it for later use
  87                 $this->setTemplateInstance($templateInstance);
  88
  89                 // Read the XML descriptor
  90                 $this->getTemplateInstance()->loadAnnouncementTemplate();
  91
  92                 // Render the XML content
  93                 $this->getTemplateInstance()->renderXmlContent();
  94         }
  95
  96         /**
  97          * Publishes the node's descriptor XML to all found upper nodes when the
  98          * node has not yet published it's descriptor to a bootstrap node. This is
  99          * done by getting the raw XML content and inserting all variables into
 100          * the code. After this wents fine, the rendered content got "packaged"
 101          * for network delivery.
 102          *
 103          * @return      void
 104          */
 105         public function sendPackage () {
 106                 // Sanity check: Is the node in the approx. state? (active)
 107                 $this->getNodeInstance()->getStateInstance()->validateNodeStateIsActive();
 108
 109                 // Compile the template, this inserts the loaded node data into the gaps.
 110                 $this->getTemplateInstance()->compileTemplate();
 111
 112                 // Get a singleton network package instance
 113                 $packageInstance = NetworkPackageFactory::createNetworkPackageInstance();
 114
 115                 // Next, feed the content in. The network package class is a pipe-through class.
 116                 $packageInstance->enqueueRawDataFromTemplate($this);
 117         }
 118
 119         /**
 120          * Getter for package tags in a simple array
 121          *
 122          * @return      $tags   An array with all tags for the currently handled package
 123          */
 124         public final function getPackageTags () {
 125                 return $this->packageTags;
 126         }
 127 }
 128
 129 // [EOF]
 130 ?>