3 * An ??? template engine class for XML templates
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
10 * @todo This template engine does not make use of setTemplateType()
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.
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.
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/>.
25 class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implements CompileableTemplate, Registerable {
27 * Some XML nodes must be available for later data extraction
29 const ANNOUNCEMENT_DATA_SESSION_ID = 'my-session-id';
30 const ANNOUNCEMENT_DATA_NODE_STATUS = 'my-status';
31 const ANNOUNCEMENT_DATA_EXTERNAL_IP = 'my-external-ip';
32 const ANNOUNCEMENT_DATA_INTERNAL_IP = 'my-internal-ip';
33 const ANNOUNCEMENT_DATA_TCP_PORT = 'my-tcp-port';
34 const ANNOUNCEMENT_DATA_UDP_PORT = 'my-udp-port';
35 const ANNOUNCEMENT_DATA_ANSWER_STATUS = 'answer-status';
38 * Protected constructor
42 protected function __construct () {
43 // Call parent constructor
44 parent::__construct(__CLASS__);
46 // Init sub-nodes array
47 $this->subNodes = array(
48 // These nodes don't contain any data
51 // Data from *this* node
52 self::ANNOUNCEMENT_DATA_EXTERNAL_IP,
53 self::ANNOUNCEMENT_DATA_INTERNAL_IP,
54 self::ANNOUNCEMENT_DATA_TCP_PORT,
55 self::ANNOUNCEMENT_DATA_UDP_PORT,
56 self::ANNOUNCEMENT_DATA_NODE_STATUS,
57 self::ANNOUNCEMENT_DATA_SESSION_ID,
58 // Data from other node
62 // Answer status (code)
63 self::ANNOUNCEMENT_DATA_ANSWER_STATUS
68 * Creates an instance of the class TemplateEngine and prepares it for usage
70 * @return $templateInstance An instance of TemplateEngine
71 * @throws BasePathIsEmptyException If the provided $templateBasePath is empty
72 * @throws InvalidBasePathStringException If $templateBasePath is no string
73 * @throws BasePathIsNoDirectoryException If $templateBasePath is no
74 * directory or not found
75 * @throws BasePathReadProtectedException If $templateBasePath is
78 public static final function createXmlAnnouncementAnswerTemplateEngine () {
80 $templateInstance = new XmlAnnouncementAnswerTemplateEngine();
83 $templateInstance->initXmlTemplateEngine('node', 'announcement_answer');
85 // Return the prepared instance
86 return $templateInstance;
90 * Load a specified announcement-answer template into the engine
92 * @param $template The announcement-answer template we shall load which is
93 * located in 'announcement_answer' by default
96 public function loadAnnouncementAnswerTemplate ($template = 'announcement_answer') {
98 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('node_announcement_answer_template_type'));
100 // Load the special template
101 $this->loadTemplate($template);
107 * @param $resource XML parser resource (currently ignored)
108 * @param $characters Characters to handle
110 * @todo Find something useful with this!
112 public function characterHandler ($resource, $characters) {
113 // Trim all spaces away
114 $characters = trim($characters);
116 // Is this string empty?
117 if (empty($characters)) {
118 // Then skip it silently
123 * Assign the found characters to variable and use the last entry from
126 parent::assignVariable($this->getStackerInstance()->getNamed('announcement_answer'), $characters);
130 * Getter for cache file (FQFN)
132 * @return $fqfn Full-qualified file name of the menu cache
134 public function getAnnouncementAnswerCacheFqfn () {
135 $this->partialStub('Please implement this method.');
139 * Starts the announcement-answer
143 protected function startAnnouncementAnswer () {
144 // Push the node name on the stacker
145 $this->getStackerInstance()->pushNamed('announcement_answer', 'announcement-answer');
153 protected function startMyData () {
154 // Push the node name on the stacker
155 $this->getStackerInstance()->pushNamed('announcement_answer', 'my-data');
159 * Starts the my-external-ip
163 protected function startMyExternalIp () {
164 // Push the node name on the stacker
165 $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_EXTERNAL_IP);
169 * Starts the my-internal-ip
173 protected function startMyInternalIp () {
174 // Push the node name on the stacker
175 $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_INTERNAL_IP);
179 * Starts the my-tcp-port
183 protected function startMyTcpPort () {
184 // Push the node name on the stacker
185 $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_TCP_PORT);
189 * Starts the my-udp-port
193 protected function startMyUdpPort () {
194 // Push the node name on the stacker
195 $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_UDP_PORT);
199 * Starts the my-session-id
203 protected function startMySessionId () {
204 // Push the node name on the stacker
205 $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_SESSION_ID);
209 * Starts the my-status
213 protected function startMyStatus () {
214 // Push the node name on the stacker
215 $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_NODE_STATUS);
219 * Finishes the my-status
223 protected function finishMyStatus () {
224 // Pop the last entry
225 $this->getStackerInstance()->popNamed('announcement_answer');
229 * Finishes the my-session-id
233 protected function finishMySessionId () {
234 // Pop the last entry
235 $this->getStackerInstance()->popNamed('announcement_answer');
239 * Finishes the my-udp-port
243 protected function finishMyUdpPort () {
244 // Pop the last entry
245 $this->getStackerInstance()->popNamed('announcement_answer');
249 * Finishes the my-tcp-port
253 protected function finishMyTcpPort () {
254 // Pop the last entry
255 $this->getStackerInstance()->popNamed('announcement_answer');
259 * Finishes the my-internal-ip
263 protected function finishMyInternalIp () {
264 // Pop the last entry
265 $this->getStackerInstance()->popNamed('announcement_answer');
269 * Finishes the my-external-ip
273 protected function finishMyExternalIp () {
274 // Pop the last entry
275 $this->getStackerInstance()->popNamed('announcement_answer');
279 * Finishes the my-data
283 protected function finishMyData () {
284 // Pop the last entry
285 $this->getStackerInstance()->popNamed('announcement_answer');
289 * Starts the your-data
293 protected function startYourData () {
294 // Push the node name on the stacker
295 $this->getStackerInstance()->pushNamed('announcement_answer', 'your-data');
299 * Starts the your-external-ip
303 protected function startYourExternalIp () {
304 // Push the node name on the stacker
305 $this->getStackerInstance()->pushNamed('announcement_answer', 'your-external-ip');
309 * Starts the your-internal-ip
313 protected function startYourInternalIp () {
314 // Push the node name on the stacker
315 $this->getStackerInstance()->pushNamed('announcement_answer', 'your-internal-ip');
319 * Starts the your-session-id
323 protected function startYourSessionId () {
324 // Push the node name on the stacker
325 $this->getStackerInstance()->pushNamed('announcement_answer', 'your-session-id');
329 * Finishes the your-session-id
333 protected function finishYourSessionId () {
334 // Pop the last entry
335 $this->getStackerInstance()->popNamed('announcement_answer');
339 * Finishes the your-internal-ip
343 protected function finishYourInternalIp () {
344 // Pop the last entry
345 $this->getStackerInstance()->popNamed('announcement_answer');
349 * Finishes the your-external-ip
353 protected function finishYourExternalIp () {
354 // Pop the last entry
355 $this->getStackerInstance()->popNamed('announcement_answer');
359 * Finishes the your-data
363 protected function finishYourData () {
364 // Pop the last entry
365 $this->getStackerInstance()->popNamed('announcement_answer');
369 * Starts the answer-status
373 protected function startAnswerStatus () {
374 // Push the node name on the stacker
375 $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_ANSWER_STATUS);
379 * Finishes the answer-status
383 protected function finishAnswerStatus () {
384 // Pop the last entry
385 $this->getStackerInstance()->popNamed('announcement_answer');
389 * Finishes the announcement-answer
393 protected function finishAnnouncementAnswer () {
394 // Pop the last entry
395 $this->getStackerInstance()->popNamed('announcement_answer');