application/hub/classes/helper/class_

   1 <?php
   2 /**
   3  * A ??? !!! 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 - 2015 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 !!!???Helper extends BaseHubSystemHelper implements Helpable!!! {
  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_```);
  37
  38                 // Set package tags
  39                 $this->setPackageTags(array('???'));
  40         }
  41
  42         /**
  43          * Creates the helper class
  44          *
  45          * @return      $helperInstance         A prepared instance of this helper
  46          */
  47         public final static function create!!!???Helper () {
  48                 // Get new instance
  49                 $helperInstance = new !!!???Helper();
  50
  51                 // Return the prepared instance
  52                 return $helperInstance;
  53         }
  54
  55         /**
  56          * Loads the descriptor XML file
  57          *
  58          * @return      void
  59          */
  60         public function loadDescriptorXml () {
  61                 $this->partialStub('Please implement this method.');
  62         }
  63
  64         /**
  65          * Do the helped attempt by delivering a package to ourselfs
  66          *
  67          * @param       $|||Instance    An instance of a !!!Helper class
  68          * @return      void
  69          */
  70         public function sendPackage (!!!Helper $|||Instance) {
  71                 // Sanity check: Is the ||| in the approx. state? (///)
  72                 $|||Instance->getStateInstance()->validate!!!StateIs+++();
  73
  74                 // Compile the template, this inserts the loaded ||| data into the gaps.
  75                 $this->getTemplateInstance()->compileTemplate();
  76
  77                 // Get a singleton network package instance
  78                 $packageInstance = NetworkPackageFactory::createNetworkPackageInstance();
  79
  80                 // Next, feed the content in. The network package class is a pipe-through class.
  81                 $packageInstance->enqueueRawDataFromTemplate($this);
  82         }
  83 }
  84
  85 // [EOF]
  86 ?>