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         /**
  26          * Template engine instance
  27          */
  28         private $templateInstance = null;
  29
  30         /**
  31          * Rendered content created by the helper class
  32          */
  33         private $content = "";
  34
  35         /**
  36          * Private constructor
  37          *
  38          * @param       $className      Real name of the class
  39          * @return      void
  40          */
  41         protected function __construct ($className) {
  42                 // Call parent constructor
  43                 parent::__construct($className);
  44
  45                 // Create unique ID number
  46                 $this->createUniqueID();
  47
  48                 // Clean up a little
  49                 $this->removeNumberFormaters();
  50                 $this->removeSystemArray();
  51         }
  52
  53         /**
  54          * Setter for template engine instances
  55          *
  56          * @param       $templateInstance       An instance of a template engine class
  57          * @return      void
  58          */
  59         protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
  60                 $this->templateInstance = $templateInstance;
  61         }
  62
  63         /**
  64          * Getter for template engine instances
  65          *
  66          * @return      $templateInstance       An instance of a template engine class
  67          */
  68         protected final function getTemplateInstance () {
  69                 return $this->templateInstance;
  70         }
  71
  72         /**
  73          * Add content
  74          *
  75          * @param       $newContent             New content to add
  76          * @return      void
  77          */
  78         protected final function addContent ($newContent) {
  79                 $this->content .= (string) trim($newContent)."\r\n";
  80         }
  81
  82         /**
  83          * Getter for content
  84          *
  85          * @return      $content        The rendered content by this helper
  86          */
  87         protected final function getContent () {
  88                 return $this->content;
  89         }
  90 }
  91
  92 // [EOF]
  93 ?>