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 BaseTemplateEngine 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 * Read announcement-answer variables by calling readVariable() with 'general' as
133 * @param $key Key to read from
134 * @return $value Value from variable
136 public function readAnnouncementAnswerData ($key) {
138 $value = parent::readVariable($key, 'general');
145 * Getter for cache file (FQFN)
147 * @return $fqfn Full-qualified file name of the menu cache
149 public function getAnnouncementAnswerCacheFqfn () {
150 $this->partialStub('Please implement this method.');
154 * Starts the announcement-answer
158 private function startAnnouncementAnswer () {
159 // Push the node name on the stacker
160 $this->getStackerInstance()->pushNamed('announcement_answer', 'announcement-answer');
168 private function startMyData () {
169 // Push the node name on the stacker
170 $this->getStackerInstance()->pushNamed('announcement_answer', 'my-data');
174 * Starts the my-external-ip
178 private function startMyExternalIp () {
179 // Push the node name on the stacker
180 $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_EXTERNAL_IP);
184 * Starts the my-internal-ip
188 private function startMyInternalIp () {
189 // Push the node name on the stacker
190 $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_INTERNAL_IP);
194 * Starts the my-tcp-port
198 private function startMyTcpPort () {
199 // Push the node name on the stacker
200 $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_TCP_PORT);
204 * Starts the my-udp-port
208 private function startMyUdpPort () {
209 // Push the node name on the stacker
210 $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_UDP_PORT);
214 * Starts the my-session-id
218 private function startMySessionId () {
219 // Push the node name on the stacker
220 $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_SESSION_ID);
224 * Starts the my-status
228 private function startMyStatus () {
229 // Push the node name on the stacker
230 $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_NODE_STATUS);
234 * Finishes the my-status
238 private function finishMyStatus () {
239 // Pop the last entry
240 $this->getStackerInstance()->popNamed('announcement_answer');
244 * Finishes the my-session-id
248 private function finishMySessionId () {
249 // Pop the last entry
250 $this->getStackerInstance()->popNamed('announcement_answer');
254 * Finishes the my-udp-port
258 private function finishMyUdpPort () {
259 // Pop the last entry
260 $this->getStackerInstance()->popNamed('announcement_answer');
264 * Finishes the my-tcp-port
268 private function finishMyTcpPort () {
269 // Pop the last entry
270 $this->getStackerInstance()->popNamed('announcement_answer');
274 * Finishes the my-internal-ip
278 private function finishMyInternalIp () {
279 // Pop the last entry
280 $this->getStackerInstance()->popNamed('announcement_answer');
284 * Finishes the my-external-ip
288 private function finishMyExternalIp () {
289 // Pop the last entry
290 $this->getStackerInstance()->popNamed('announcement_answer');
294 * Finishes the my-data
298 private function finishMyData () {
299 // Pop the last entry
300 $this->getStackerInstance()->popNamed('announcement_answer');
304 * Starts the your-data
308 private function startYourData () {
309 // Push the node name on the stacker
310 $this->getStackerInstance()->pushNamed('announcement_answer', 'your-data');
314 * Starts the your-external-ip
318 private function startYourExternalIp () {
319 // Push the node name on the stacker
320 $this->getStackerInstance()->pushNamed('announcement_answer', 'your-external-ip');
324 * Starts the your-internal-ip
328 private function startYourInternalIp () {
329 // Push the node name on the stacker
330 $this->getStackerInstance()->pushNamed('announcement_answer', 'your-internal-ip');
334 * Starts the your-session-id
338 private function startYourSessionId () {
339 // Push the node name on the stacker
340 $this->getStackerInstance()->pushNamed('announcement_answer', 'your-session-id');
344 * Finishes the your-session-id
348 private function finishYourSessionId () {
349 // Pop the last entry
350 $this->getStackerInstance()->popNamed('announcement_answer');
354 * Finishes the your-internal-ip
358 private function finishYourInternalIp () {
359 // Pop the last entry
360 $this->getStackerInstance()->popNamed('announcement_answer');
364 * Finishes the your-external-ip
368 private function finishYourExternalIp () {
369 // Pop the last entry
370 $this->getStackerInstance()->popNamed('announcement_answer');
374 * Finishes the your-data
378 private function finishYourData () {
379 // Pop the last entry
380 $this->getStackerInstance()->popNamed('announcement_answer');
384 * Starts the answer-status
388 private function startAnswerStatus () {
389 // Push the node name on the stacker
390 $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_ANSWER_STATUS);
394 * Finishes the answer-status
398 private function finishAnswerStatus () {
399 // Pop the last entry
400 $this->getStackerInstance()->popNamed('announcement_answer');
404 * Finishes the announcement-answer
408 private function finishAnnouncementAnswer () {
409 // Pop the last entry
410 $this->getStackerInstance()->popNamed('announcement_answer');