3 * An SelfConnect template engine class for XML templates
5 * @author Roland Haeder <webmaster@shipsimu.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.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 XmlSelfConnectTemplateEngine extends BaseXmlTemplateEngine implements CompileableTemplate, Registerable {
29 const SELF_CONNECT_DATA_NODE_ID = 'node-id';
30 const SELF_CONNECT_DATA_SESSION_ID = 'session-id';
33 * Protected constructor
37 protected function __construct () {
38 // Call parent constructor
39 parent::__construct(__CLASS__);
42 $this->subNodes = array(
44 self::SELF_CONNECT_DATA_NODE_ID,
45 self::SELF_CONNECT_DATA_SESSION_ID
50 * Creates an instance of the class TemplateEngine and prepares it for usage
52 * @return $templateInstance An instance of TemplateEngine
53 * @throws BasePathIsEmptyException If the provided $templateBasePath is empty
54 * @throws InvalidBasePathStringException If $templateBasePath is no string
55 * @throws BasePathIsNoDirectoryException If $templateBasePath is no
56 * directory or not found
57 * @throws BasePathReadProtectedException If $templateBasePath is
60 public static final function createXmlSelfConnectTemplateEngine () {
62 $templateInstance = new XmlSelfConnectTemplateEngine();
64 // Init template instance
65 $templateInstance->initXmlTemplateEngine('node', 'self_connect');
67 // Return the prepared instance
68 return $templateInstance;
74 * @param $resource XML parser resource (currently ignored)
75 * @param $characters Characters to handle
77 * @todo Find something useful with this!
79 public function characterHandler ($resource, $characters) {
80 // Trim all spaces away
81 $characters = trim($characters);
83 // Is this string empty?
84 if (empty($characters)) {
85 // Then skip it silently
90 * Assign the found characters to variable and use the last entry from
93 parent::assignVariable($this->getStackerInstance()->getNamed('node_self_connect'), $characters);
97 * Getter for cache file (FQFN)
99 * @return $fqfn Full-qualified file name of the menu cache
101 public function getMenuCacheFqfn () {
102 $this->partialStub('Please implement this method.');
106 * Starts the self_connect
110 protected function startSelfConnect () {
111 // Push the node name on the stacker
112 $this->getStackerInstance()->pushNamed('node_self_connect', 'self-connect');
116 * Starts the self_connect data
120 protected function startSelfConnectData () {
121 // Push the node name on the stacker
122 $this->getStackerInstance()->pushNamed('node_self_connect', 'self-connect-data');
130 protected function startNodeId () {
131 // Push the node name on the stacker
132 $this->getStackerInstance()->pushNamed('node_self_connect', self::SELF_CONNECT_DATA_NODE_ID);
136 * Starts the session id
140 protected function startSessionId () {
141 // Push the node name on the stacker
142 $this->getStackerInstance()->pushNamed('node_self_connect', self::SELF_CONNECT_DATA_SESSION_ID);
146 * Finishes the session id
150 protected function finishSessionId () {
151 // Pop the last entry
152 $this->getStackerInstance()->popNamed('node_self_connect');
156 * Finishes the node id
160 protected function finishNodeId () {
161 // Pop the last entry
162 $this->getStackerInstance()->popNamed('node_self_connect');
166 * Finishes the self_connect data
170 protected function finishSelfConnectData () {
171 // Pop the last entry
172 $this->getStackerInstance()->popNamed('node_self_connect');
176 * Finishes the self_connect
180 protected function finishSelfConnect () {
181 // Pop the last entry
182 $this->getStackerInstance()->popNamed('node_self_connect');