application/hub/main/helper/hub/connection/class_HubSelfConnectHelper.php

   1 <?php
   2 /**
   3  * A SelfConnect 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, 2010 Core 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 HubSelfConnectHelper extends BaseHubHelper implements HelpableHub {
  26         /**
  27          * Protected constructor
  28          *
  29          * @return      void
  30          */
  31         protected function __construct () {
  32                 // Call parent constructor
  33                 parent::__construct(__CLASS__);
  34         }
  35
  36         /**
  37          * Creates the helper class
  38          *
  39          * @return      $helperInstance         A prepared instance of this helper
  40          */
  41         public final static function createHubSelfConnectHelper () {
  42                 // Get new instance
  43                 $helperInstance = new HubSelfConnectHelper();
  44
  45                 // Return the prepared instance
  46                 return $helperInstance;
  47         }
  48
  49         /**
  50          * Loads the descriptor XML file
  51          *
  52          * @return      void
  53          */
  54         public function loadDescriptorXml () {
  55                 $this->partialStub('Please implement this method.');
  56         }
  57
  58         /**
  59          * Do the self-connect attempt by delivering a package to ourselfs
  60          *
  61          * @return      void
  62          */
  63         public function sendPackage () {
  64                 // Sanity check: Is the node in the approx. state? (active)
  65                 $this->getNodeInstance()->getStateInstance()->validateNodeStateIsActive();
  66
  67                 // Compile the template, this inserts the loaded node data into the gaps.
  68                 $this->getTemplateInstance()->compileTemplate();
  69
  70                 // Get a singleton network package instance
  71                 $packageInstance = NetworkPackageFactory::createNetworkPackageInstance();
  72
  73                 // Next, feed the content in. The network package class is a pipe-through class.
  74                 $packageInstance->enqueueRawDataFromTemplate($this);
  75         }
  76 }
  77
  78 // [EOF]
  79 ?>