]> git.mxchange.org Git - hub.git/blob - application/hub/main/helper/hub/class_
Self-connect continued (still broken), some code moved to generic classes to encapsul...
[hub.git] / application / hub / main / helper / hub / class_
1 <?php
2 /**
3  * A ??? 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 Hub???Helper 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                 // Set recipient type
36                 $this->setRecipientType(NetworkPackage::NETWORK_TARGET_!!!);
37         }
38
39         /**
40          * Creates the helper class
41          *
42          * @return      $helperInstance         A prepared instance of this helper
43          */
44         public final static function createHub???Helper () {
45                 // Get new instance
46                 $helperInstance = new Hub???Helper();
47
48                 // Return the prepared instance
49                 return $helperInstance;
50         }
51
52         /**
53          * Loads the descriptor XML file
54          *
55          * @return      void
56          */
57         public function loadDescriptorXml () {
58                 $this->partialStub('Please implement this method.');
59         }
60
61         /**
62          * Do the helped attempt by delivering a package to ourselfs
63          *
64          * @return      void
65          */
66         public function sendPackage () {
67                 // Sanity check: Is the node in the approx. state? (active)
68                 $this->getNodeInstance()->getStateInstance()->validateNodeStateIsActive();
69
70                 // Compile the template, this inserts the loaded node data into the gaps.
71                 $this->getTemplateInstance()->compileTemplate();
72
73                 // Get a singleton network package instance
74                 $packageInstance = NetworkPackageFactory::createNetworkPackageInstance();
75
76                 // Next, feed the content in. The network package class is a pipe-through class.
77                 $packageInstance->enqueueRawDataFromTemplate($this);
78         }
79 }
80
81 // [EOF]
82 ?>