]> git.mxchange.org Git - hub.git/blob - application/hub/main/helper/hub/connection/class_HubSelfConnectHelper.php
Self-connect continued (still broken), some code moved to generic classes to encapsul...
[hub.git] / 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          * Package tags
28          */
29         private $packageTags = array('self_connect');
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_SELF);
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 final static function createHubSelfConnectHelper (NodeHelper $nodeInstance) {
51                 // Get new instance
52                 $helperInstance = new HubSelfConnectHelper();
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 descriptor XML file
63          *
64          * @return      void
65          */
66         public function loadDescriptorXml () {
67                 // Debug message
68                 $this->debugOutput('HELPER: Attempting self-connect...');
69
70                 // Get the application instance
71                 $appInstance = Registry::getRegistry()->getInstance('app');
72
73                 // Get a XML template instance
74                 $templateInstance = ObjectFactory::createObjectByConfiguredName('self_connect_template_class', array($appInstance));
75
76                 // Disable language support
77                 $templateInstance->enableLanguageSupport(false);
78
79                 /*
80                  * Enable compacting/rewriting of the  XML to save bandwidth from XML
81                  * comments. This is expensive and should be avoided in general.
82                  */
83                 $templateInstance->enableXmlCompacting();
84
85                 // Set it for later use
86                 $this->setTemplateInstance($templateInstance);
87
88                 // Read the XML descriptor
89                 $this->getTemplateInstance()->loadSelfConnectTemplate();
90
91                 // Render the XML content
92                 $this->getTemplateInstance()->renderXmlContent();
93         }
94
95         /**
96          * Do the self-connect attempt by delivering a package to ourselfs
97          *
98          * @return      void
99          */
100         public function sendPackage () {
101                 // Sanity check: Is the node in the approx. state? (active)
102                 $this->getNodeInstance()->getStateInstance()->validateNodeStateIsActive();
103
104                 // Compile the template, this inserts the loaded node data into the gaps.
105                 $this->getTemplateInstance()->compileTemplate();
106
107                 // Get a singleton network package instance
108                 $packageInstance = NetworkPackageFactory::createNetworkPackageInstance();
109
110                 // Next, feed the content in. The network package class is a pipe-through class.
111                 $packageInstance->enqueueRawDataFromTemplate($this);
112         }
113
114         /**
115          * Getter for package tags in a simple array
116          *
117          * @return      $tags   An array with all tags for the currently handled package
118          */
119         public final function getPackageTags () {
120                 return $this->packageTags;
121         }
122 }
123
124 // [EOF]
125 ?>