3 * A generic helper class with generic methods
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class BaseHelper extends BaseFrameworkSystem {
25 // Exception constants
26 const EXCEPTION_XML_PARSER_ERROR = 0x0d0;
27 const EXCEPTION_XML_NODE_UNKNOWN = 0x0d1;
30 * Template engine instance
32 private $templateInstance = null;
35 * Rendered content created by the helper class
37 private $content = "";
40 * Protected constructor
42 * @param $className Real name of the class
45 protected function __construct ($className) {
46 // Call parent constructor
47 parent::__construct($className);
50 $this->removeNumberFormaters();
51 $this->removeSystemArray();
55 * Setter for template engine instances
57 * @param $templateInstance An instance of a template engine class
60 protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
61 $this->templateInstance = $templateInstance;
65 * Getter for template engine instances
67 * @return $templateInstance An instance of a template engine class
69 protected final function getTemplateInstance () {
70 return $this->templateInstance;
76 * @param $newContent New content to add
79 protected final function addContent ($newContent) {
80 $this->content .= (string) trim($newContent)."\r\n";
86 * @return $content The rendered content by this helper
88 protected final function getContent () {
89 return $this->content;