inc/classes/main/helper/class_BaseHelper.php

   1 <?php
   2 /**
   3  * A generic helper class with generic methods
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   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
  10  *
  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.
  15  *
  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.
  20  *
  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/>.
  23  */
  24 class BaseHelper extends BaseFrameworkSystem {
  25         // Exception constants
  26         const EXCEPTION_XML_PARSER_ERROR = 0x0d0;
  27         const EXCEPTION_XML_NODE_UNKNOWN = 0x0d1;
  28
  29         /**
  30          * Template engine instance
  31          */
  32         private $templateInstance = null;
  33
  34         /**
  35          * Rendered content created by the helper class
  36          */
  37         private $content = "";
  38
  39         /**
  40          * Protected constructor
  41          *
  42          * @param       $className      Real name of the class
  43          * @return      void
  44          */
  45         protected function __construct ($className) {
  46                 // Call parent constructor
  47                 parent::__construct($className);
  48
  49                 // Clean up a little
  50                 $this->removeNumberFormaters();
  51                 $this->removeSystemArray();
  52         }
  53
  54         /**
  55          * Setter for template engine instances
  56          *
  57          * @param       $templateInstance       An instance of a template engine class
  58          * @return      void
  59          */
  60         protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
  61                 $this->templateInstance = $templateInstance;
  62         }
  63
  64         /**
  65          * Getter for template engine instances
  66          *
  67          * @return      $templateInstance       An instance of a template engine class
  68          */
  69         protected final function getTemplateInstance () {
  70                 return $this->templateInstance;
  71         }
  72
  73         /**
  74          * Add content
  75          *
  76          * @param       $newContent             New content to add
  77          * @return      void
  78          */
  79         protected final function addContent ($newContent) {
  80                 $this->content .= (string) trim($newContent)."\r\n";
  81         }
  82
  83         /**
  84          * Getter for content
  85          *
  86          * @return      $content        The rendered content by this helper
  87          */
  88         protected final function getContent () {
  89                 return $this->content;
  90         }
  91 }
  92
  93 // [EOF]
  94 ?>