Source for file Basic.class.php

Documentation is available at Basic.class.php

  1. <?php
  2. /**
  3.  * Gumbo Library Framework
  4.  *
  5.  * LICENSE
  6.  * This library is being released under the terms of the New BSD License.  A
  7.  * copy of the license is packaged with the software (LICENSE.txt).  If no
  8.  * copy is found, a copy of the license template can be found at:
  9.  * http://www.opensource.org/licenses/bsd-license.php
  10.  * 
  11.  * @category Gumbo
  12.  * @package Template
  13.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  14.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  15.  * @author Michael Luster <mluster79@yahoo.com>
  16.  * @link http://sourceforge.net/projects/phpgumbo
  17.  * @version 0.0.1
  18.  */
  19.  
  20. /**
  21.  * Basic Template Engine Class
  22.  * 
  23.  * This Engine will perform a simple string replacement with the
  24.  * template variables.  The template file will hold references
  25.  * to the template.  The references will be contained within
  26.  * left and right delimeters.  A template reference will look
  27.  * like:
  28.  * {reference}
  29.  * 
  30.  * The left and right delimeters can be altered from the defaults.  It's
  31.  * important that these values are accurate, for the replacement of the
  32.  * references will not work.
  33.  *
  34.  * @category Gumbo
  35.  * @package Template
  36.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  37.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  38.  * @author Michael Luster <mluster79@yahoo.com>
  39.  * @link http://sourceforge.net/projects/phpgumbo
  40.  * @desc Basic Template Engine Class
  41.  * @version 0.0.1
  42.  */
  43.  
  44. gumbo_load ("Template_Engine");
  45.  
  46. class Gumbo_Template_Engine_Basic extends Gumbo_Template_Engine {
  47.     
  48.     /**
  49.      * Constructor
  50.      * @param string $file template file name
  51.      */
  52.     public function __construct ($file=null) {
  53.         if (!is_null ($file)) { $this->setFile ($file); }
  54.         
  55.         $this->setLeftDelimeter ("{");
  56.         $this->setRightDelimeter ("}");
  57.     }
  58.     
  59.     
  60.     
  61.     /** ACTION METHODS **/
  62.     /**
  63.      * Parses the template file into an HTML string
  64.      * @precondition $this->setFormatted (false)
  65.      * @precondition $this->setHtml (null)
  66.      * @postcondition $this->isFormatted ()
  67.      */
  68.     protected function parse () {
  69.         // verify precondition
  70.         $this->setFormatted (false);
  71.         $this->setOutput (null);
  72.         
  73.         $contents = file_get_contents ($this->getFullPath ());
  74.         
  75.         // loop through the template variables
  76.         foreach ($this->getVars () as $key=>$val) {
  77.             $ref = $this->getLeftDelimeter () . $key . $this->getRightDelimeter ();
  78.             if (is_object ($val) && $val instanceof Gumbo_Interface_Output) {
  79.                 $val = $val->fetch ();
  80.             }
  81.             $contents = str_replace ($ref, $val, $contents);
  82.         }
  83.         
  84.         $this->setOutput ($contents);
  85.         $this->setFormatted (true);
  86.     }
  87.     
  88.     
  89.     
  90.     /** MUTATOR METHODS **/
  91.     /**
  92.      * Assigns a template variable with a value
  93.      * @precondition must be primitive type
  94.      * @param string|array$key template file reference
  95.      * @param mixed $val (primitive type or Gumbo_Interface_Output)
  96.      * @throws Gumbo_Exception
  97.      */
  98.     public function assign ($key, $val=null) {
  99.         try {
  100.             // verify precondition
  101.             if (!is_string ($key) && !is_array ($key)) {
  102.                 throw new Gumbo_Exception ("Invalid Argument 'key:str|arr' => {$key}:" . gettype ($key));
  103.             }
  104.             
  105.             // check for an array
  106.             if (is_array ($key)) {
  107.                 foreach ($key as $ref=>$value) {
  108.                     $this->assign ($ref, $value);
  109.                 }
  110.                 return;
  111.             }
  112.             
  113.             // verify precondition
  114.             // ensures only a primitive type is assigned to this engine
  115.             if (!is_null ($val) && !is_bool ($val) && !is_string ($val) && !is_numeric ($val) && !is_object ($val)) {
  116.                  throw new Gumbo_Exception ("Invalid Argument 'val:bool|num|str|null|Gumbo_Interface_Output' => {$key}:" . gettype ($val)); 
  117.             }
  118.             
  119.             // verify the Object is a Gumbo_Template_Engine
  120.             if (is_object ($val) && !($val instanceof Gumbo_Interface_Output)) {
  121.                 throw new Gumbo_Exception ("Invalid Argument 'val:Gumbo_Interface_Output' => {$val}:" . gettype ($val));
  122.             }
  123.             
  124.             // default assignment
  125.             $this->_vars [$key] = $val;
  126.         } catch (Gumbo_Exception $e) {
  127.             $e->setFunction (__METHOD__);
  128.             gumbo_trigger ($e);
  129.         }
  130.     }
  131.     
  132. }
  133.  
  134. ?>