3 * An RequestNodeListEntry 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 die('YOU NEED TO REPLACE RequestNodeListEntry, request_node_list_entry AND request-node-list-entry IN THIS CLASS BEFORE YOU CAN USE IT.');
26 class XmlRequestNodeListEntryTemplateEngine extends BaseXmlTemplateEngine implements CompileableTemplate, Registerable {
28 * Protected constructor
32 protected function __construct () {
33 // Call parent constructor
34 parent::__construct(__CLASS__);
38 * Creates an instance of the class TemplateEngine and prepares it for usage
40 * @return $templateInstance An instance of TemplateEngine
41 * @throws BasePathIsEmptyException If the provided $templateBasePath is empty
42 * @throws InvalidBasePathStringException If $templateBasePath is no string
43 * @throws BasePathIsNoDirectoryException If $templateBasePath is no
44 * directory or not found
45 * @throws BasePathReadProtectedException If $templateBasePath is
48 public static final function createXmlRequestNodeListEntryTemplateEngine () {
50 $templateInstance = new XmlRequestNodeListEntryTemplateEngine();
52 // Init template instannce
53 $templateInstance->initXmlTemplateEngine('node', 'request_node_list_entry');
55 // Return the prepared instance
56 return $templateInstance;
62 * @param $resource XML parser resource (currently ignored)
63 * @param $characters Characters to handle
65 * @todo Find something useful with this!
67 public function characterHandler ($resource, $characters) {
68 // Trim all spaces away
69 $characters = trim($characters);
71 // Is this string empty?
72 if (empty($characters)) {
73 // Then skip it silently
77 // Assign data with matching variable here
78 parent::assignVariable($this->getStackerInstance()->getNamed('node_request_node_list_entry'), $characters);
82 * Getter for cache file (FQFN)
84 * @return $fqfn Full-qualified file name of the menu cache
86 public function getRequestNodeListEntryCacheFqfn () {
87 $this->partialStub('Please implement this method.');
91 * Starts the request-node-list-entry
95 protected function startRequestNodeListEntry () {
96 // Push the node name on the stacker
97 $this->getStackerInstance()->pushNamed('node_request_node_list_entry', 'request-node-list-entry');
101 * Finishes the request-node-list-entry
105 protected function finishRequestNodeListEntry () {
106 // Pop the last entry
107 $this->getStackerInstance()->popNamed('node_request_node_list_entry');