3 * A RequestNodeListAnswer 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 XmlRequestNodeListAnswerTemplateEngine extends BaseXmlTemplateEngine implements CompileableTemplate, Registerable {
26 // Constants for array elements
27 const REQUEST_DATA_SESSION_ID = 'session-id';
28 const REQUEST_DATA_NODE_LIST = 'node-list';
31 * Protected constructor
35 protected function __construct () {
36 // Call parent constructor
37 parent::__construct(__CLASS__);
39 // Init sub-nodes array
40 $this->subNodes = array(
41 self::REQUEST_DATA_SESSION_ID,
42 self::REQUEST_DATA_NODE_LIST,
47 * Creates an instance of the class TemplateEngine and prepares it for usage
49 * @return $templateInstance An instance of TemplateEngine
50 * @throws BasePathIsEmptyException If the provided $templateBasePath is empty
51 * @throws InvalidBasePathStringException If $templateBasePath is no string
52 * @throws BasePathIsNoDirectoryException If $templateBasePath is no
53 * directory or not found
54 * @throws BasePathReadProtectedException If $templateBasePath is
57 public static final function createXmlRequestNodeListAnswerTemplateEngine () {
59 $templateInstance = new XmlRequestNodeListAnswerTemplateEngine();
62 $templateInstance->initXmlTemplateEngine('node', 'request_node_list_answer');
64 // Get a template instance for list entries (as they are dynamic)
65 $entriesInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('node_request_node_list_entries_template_class');
68 $templateInstance->setTemplateInstance($entriesInstance);
70 // Return the prepared instance
71 return $templateInstance;
77 * @param $resource XML parser resource (currently ignored)
78 * @param $characters Characters to handle
80 * @todo Find something useful with this!
82 public function characterHandler ($resource, $characters) {
83 // Trim all spaces away
84 $characters = trim($characters);
86 // Is this string empty?
87 if (empty($characters)) {
88 // Then skip it silently
93 * Assign the found characters to variable and use the last entry from
96 parent::assignVariable($this->getStackerInstance()->getNamed('node_request_node_list_answer'), $characters);
100 * Getter for cache file (FQFN)
102 * @return $fqfn Full-qualified file name of the menu cache
104 public function getRequestNodeListAnswerCacheFqfn () {
105 $this->partialStub('Please implement this method.');
109 * Starts the 'request-node-list-answer'
113 protected function startRequestNodeListAnswer () {
114 // Push the node name on the stacker
115 $this->getStackerInstance()->pushNamed('node_request_node_list_answer', 'request-node-list-answer');
119 * Starts the session-id
123 protected function startSessionId () {
124 // Push the node name on the stacker
125 $this->getStackerInstance()->pushNamed('node_request_node_list_answer', self::REQUEST_DATA_SESSION_ID);
129 * Starts the node-list
133 protected function startNodeList () {
134 // Push the node name on the stacker
135 $this->getStackerInstance()->pushNamed('node_request_node_list_answer', self::REQUEST_DATA_NODE_LIST);
139 * Finishes the node-list
143 protected function finishNodeList () {
144 // Pop the last entry
145 $this->getStackerInstance()->popNamed('node_request_node_list_answer');
149 * Finishes the session-id
153 protected function finishSessionId () {
154 // Pop the last entry
155 $this->getStackerInstance()->popNamed('node_request_node_list_answer');
159 * Finishes the 'request-node-list-answer'
163 protected function finishRequestNodeListAnswer () {
164 // Pop the last entry
165 $this->getStackerInstance()->popNamed('node_request_node_list_answer');