Source for file Internal.class.php

Documentation is available at Internal.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.  * Internal Template Engine Class
  22.  * 
  23.  * The Internal Template Engine will include a template file into the
  24.  * parse method.  The engine will include the file as if the contents
  25.  * were written inside the method.  The Template file should contain
  26.  * HTML and PHP code intermixed.  The use of <?php .. ?> tags is recommended.
  27.  * The Template file should output the results to the browser.  The contents
  28.  * will be caught inside a buffer and the contents saved into the object.
  29.  * 
  30.  * Template File:
  31.  * <pre>
  32.  * ...
  33.  * <?php echo $this->template_variable; ?>
  34.  * ...
  35.  * </pre>
  36.  *
  37.  * @category Gumbo
  38.  * @package Template
  39.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  40.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  41.  * @author Michael Luster <mluster79@yahoo.com>
  42.  * @link http://sourceforge.net/projects/phpgumbo
  43.  * @desc Internal Template Engine Class
  44.  * @version 0.0.1
  45.  */
  46.  
  47. gumbo_load ("Template_Engine");
  48.  
  49. class Gumbo_Template_Engine_Internal extends Gumbo_Template_Engine {
  50.     
  51.     /**
  52.      * Constructor
  53.      * @param string $file template file name
  54.      */
  55.     public function __construct ($file=null) {
  56.         if (!is_null ($file)) { $this->setFile ($file); }
  57.     }
  58.     
  59.     
  60.     
  61.     /** ACTION METHODS **/
  62.     /**
  63.      * Parses the template file into an HTML string
  64.      * @precondition setFormatted (false)
  65.      * @precondition setOutput (null)
  66.      * @postcondition isFormatted ()
  67.      */
  68.     protected function parse () {
  69.         // verify precondition
  70.         $this->setFormatted (false);
  71.         $this->setOutput (null);
  72.         
  73.         // start the buffer
  74.         // NOTE: Gumbo_Buffer not used to avoid dependency
  75.         ob_start ();
  76.             include ($this->getFullPath ());
  77.             $contents = ob_get_contents ();
  78.         ob_end_clean ();
  79.         
  80.         $this->setOutput ($contents);
  81.         $this->setFormatted (true);
  82.     }
  83.     
  84. }
  85.  
  86. ?>