3 * An ??? template engine class for XML templates
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.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 XmlRequestNodeListTemplateEngine extends BaseXmlTemplateEngine implements CompileableTemplate, Registerable {
26 // Constants for array elements
27 const REQUEST_DATA_ACCEPTED_OBJECT_TYPES = 'accepted-object-types';
28 const REQUEST_DATA_SESSION_ID = 'session-id';
31 * Protected constructor
35 protected function __construct () {
36 // Call parent constructor
37 parent::__construct(__CLASS__);
40 $this->setSubNodes(array(
41 self::REQUEST_DATA_ACCEPTED_OBJECT_TYPES,
42 self::REQUEST_DATA_SESSION_ID,
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 createXmlRequestNodeListTemplateEngine () {
59 $templateInstance = new XmlRequestNodeListTemplateEngine();
61 // Init template instance
62 $templateInstance->initXmlTemplateEngine('node', 'request_node_list');
64 // Return the prepared instance
65 return $templateInstance;
71 * @param $resource XML parser resource (currently ignored)
72 * @param $characters Characters to handle
74 * @todo Find something useful with this!
76 public function characterHandler ($resource, $characters) {
77 // Trim all spaces away
78 $characters = trim($characters);
80 // Is this string empty?
81 if (empty($characters)) {
82 // Then skip it silently
86 // Assign data with matching variable here
87 parent::assignVariable($this->getStackInstance()->getNamed('node_request_node_list'), $characters);
91 * Getter for cache file (FQFN)
93 * @return $fqfn Full-qualified file name of the menu cache
95 public function getRequestNodeListCacheFqfn () {
96 $this->partialStub('Please implement this method.');
100 * Starts the node-request-node-list
104 protected function startRequestNodeList () {
105 // Push the node name on the stacker
106 $this->getStackInstance()->pushNamed('node_request_node_list', 'node-request-node-list');
110 * Starts the accepted-object-types
114 protected function startAcceptedObjectTypes () {
115 // Push the node name on the stacker
116 $this->getStackInstance()->pushNamed('node_request_node_list', self::REQUEST_DATA_ACCEPTED_OBJECT_TYPES);
120 * Starts the session-id
124 protected function startSessionId () {
125 // Push the node name on the stacker
126 $this->getStackInstance()->pushNamed('node_request_node_list', self::REQUEST_DATA_SESSION_ID);
130 * Finishes the session-id
134 protected function finishSessionId () {
135 // Pop the last entry
136 $this->getStackInstance()->popNamed('node_request_node_list');
140 * Finishes the accepted-object-types
144 protected function finishAcceptedObjectTypes () {
145 // Pop the last entry
146 $this->getStackInstance()->popNamed('node_request_node_list');
150 * Finishes the node-request-node-list
154 protected function finishRequestNodeList () {
155 // Pop the last entry
156 $this->getStackInstance()->popNamed('node_request_node_list');