Source for file Template.class.php

Documentation is available at Template.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.  * Template Interface, defines global Template properties
  22.  *
  23.  * @category Gumbo
  24.  * @package Template
  25.  * @copyright Copyright (c) 2007, iBayou, Michael Luster
  26.  * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
  27.  * @author Michael Luster <mluster79@yahoo.com>
  28.  * @link http://sourceforge.net/projects/phpgumbo
  29.  * @desc Template Interface
  30.  * @version 0.0.1
  31.  */
  32.  
  33. interface Gumbo_Interface_Template {
  34.     
  35.     
  36.     
  37.     /** ACTION METHODS **/
  38.     /**
  39.      * Assigns a global template variable
  40.      * 
  41.      * All global template variable references will be prepended with
  42.      * "global_*" string.  This will separate the global variables from
  43.      * local template variables.
  44.      * 
  45.      * @precondition must be a primitive type
  46.      * @param string|array$key template reference
  47.      * @param mixed $val template value
  48.      */
  49.     public static function assign ($key, $val=null);
  50.     
  51.     /**
  52.      * Removes the global variable assignment
  53.      * @param string $key template variable reference
  54.      */
  55.     public static function unassign ($key);
  56.     
  57.     
  58.     
  59.     /** MUTATOR METHODS **/
  60.     /**
  61.      * Sets the global template engine to use
  62.      * @param string $engine 
  63.      */
  64.     public static function setEngine ($engine);
  65.     
  66.     /**
  67.      * Sets the global template file directory
  68.      * @precondition is_dir ($loc)
  69.      * @param string $loc 
  70.      */
  71.     public static function setDirTpl ($loc);
  72.     
  73.     /**
  74.      * Sets the global template file compile directory
  75.      * @precondition is_dir ($loc)
  76.      * @param string $loc 
  77.      */
  78.     public static function setDirCompile ($loc);
  79.     
  80.     /**
  81.      * Sets the global template file cache directory
  82.      * @precondition is_dir ($loc)
  83.      * @param string $loc 
  84.      */
  85.     public static function setDirCache ($loc);
  86.     
  87.     /**
  88.      * Sets the global template file config directory
  89.      * @precondition is_dir ($loc)
  90.      * @param string $loc 
  91.      */
  92.     public static function setDirConfig ($loc);
  93.     
  94.     /**
  95.      * Sets the global left delimeter value
  96.      * @param string $val 
  97.      */
  98.     public static function setLeftDelimeter ($val);
  99.     
  100.     /**
  101.      * Sets the global right delimeter value
  102.      * @param string $val 
  103.      */
  104.     public static function setRightDelimeter ($val);
  105.     
  106.     
  107.     
  108.     /** ACCESSOR METHODS **/
  109.     /**
  110.      * Returns the global template engine
  111.      * @return string 
  112.      */
  113.     public static function getEngine ();
  114.     
  115.     /**
  116.      * Returns a global template variable value
  117.      * @param string $key variable reference
  118.      * @return mixed 
  119.      */
  120.     public static function getVar ($key);
  121.     
  122.     /**
  123.      * Returns all the global template variables
  124.      * @return array 
  125.      */
  126.     public static function getVars ();
  127.     
  128.     /**
  129.      * Returns the global Template directory
  130.      * @return string 
  131.      */
  132.     public static function getDirTpl ();
  133.     
  134.     /**
  135.      * Returns the global Template compile directory
  136.      * @return string 
  137.      */
  138.     public static function getDirCompile ();
  139.     
  140.     /**
  141.      * Returns the global Template cache directory
  142.      * @return string 
  143.      */
  144.     public static function getDirCache ();
  145.     
  146.     /**
  147.      * Returns the global Template config directory
  148.      * @return string 
  149.      */
  150.     public static function getDirConfig ();
  151.     
  152.     /**
  153.      * Returns the global left delimeter
  154.      * @return string 
  155.      */
  156.     public static function getLeftDelimeter ();
  157.     
  158.     /**
  159.      * Returns the global right delimeter
  160.      * @return string 
  161.      */
  162.     public static function getRightDelimeter ();
  163.     
  164.     
  165.     
  166.     /**
  167.      * Returns if the Template Engine exists
  168.      * @param string $engine 
  169.      * @return bool 
  170.      */
  171.     public static function isEngine ($engine);
  172.     
  173. }
  174.  
  175. ?>