File Source for tangra_simple

<?php
// *** Tangra (Application Framework and Tools for PHP)
// $Id$
//
/**
* Contains class Tangra_Simple_Tple
* @package tangra_lib
* @subpackage core
*/
/**
* Loading parent class
*/
require_once(TANGRA_MAIN_DIR.'core/tangra_class.class.php');
/**
* Loading interface
*/
require_once(TANGRA_MAIN_DIR.'interfaces/i_tple.class.php');
/**
* Tangra Simple_Tple version
*
*/
define('TANGRA_MODULE_SIMPLE_TPLE', '1.0');
/**
* Contains detected value for Tangra_Simple_Tple directory.
*
*/
define('TANGRA_MODULE_SIMPLE_TPLE_DIR', dirname(__FILE__).'/');
/**
* Minimal version of Tangra_Lib that is required by Tangra_Simple_Tple.
* This may become deprecated - it was inteded to be used if Tangra_Simple_Tple is separate module.
*
*/
define('TANGRA_MODULE_SIMPLE_TPLE_MIN_TANGRA_VERSION', '2.0.0');
require_once(TANGRA_MAIN_DIR.'exceptions/te_tple_path_not_exists.class.php');
require_once(TANGRA_MAIN_DIR.'exceptions/te_tple_file_not_exists.class.php');
require_once(TANGRA_MAIN_DIR.'exceptions/te_var_already_exists.class.php');
/**
* Very basic template engine.
*
* Used by installers of site templates (we don't want to configure "mastodont" template engine every time when we do installaton, do we?)
* @package tangra_lib
* @subpackage core
*/
class Tangra_Simple_Tple extends Tangra_Class implements I_Tple {
/**
* Path to templates directory.
*
* @var string
* @access private
*/
private $tpl_path;
/**
* Contains assigned by Tangra_Simple_Tple::assign() values. This values will be used to replace all tags in the template.
* It is simple associative array $key => $value
*
* @var array Simple associative array
* @access private
*/
private $vars = array();
/**
* Left delimiter for tags. Default is {@
*
* @var string
* $access private
*/
private $left_delimiter; // left sequence for tags
/**
* Right delimiter for tags. Default is @}
*
* @var string
*/
private $right_delimiter; // right sequence for tag
/**
* Sets template paths and throws exception if the path is not existing.
*
* @param string $tpl_path path to template directory
* @param string $ld left delimiter for tags. Default is {@
* @param string $rd right delimiter for tags. Default is @}
* @throws Tangra_Exception
*/
function __construct($tpl_path = NULL, $ld = '{@', $rd = '@}') {
if (!version_compare(TANGRA_MODULE_SIMPLE_TPLE_MIN_TANGRA_VERSION, TANGRA_VERSION, '<=')) {
throw new Tangra_Exception('Can not initialize Tangra_Simple_Tple - Tangra lib version '.TANGRA_MODULE_SIMPLE_TPLE_MIN_TANGRA_VERSION.' or newer required. Current version is: '.TANGRA_VERSION);
}
$this->set_tpl_dir($tpl_path);
$this->set_left_delimiter($ld);
$this->set_right_delimiter($rd);
}
/**
* Parses and displays template file.
*
* @param string $tpl file to be showed
*/
public function display($tpl) {
print($this->fetch($tpl));
}
/**
* Parses $content and returns it with all tags replaced with assigned values.
*
* @param string $content content to be parsed
* @param boolean $strip_unused_tags if true will strip tags that are not replaced (this happens when there are tags in the $content but no values are provided for them with assign())
* @return string parsed content
*/
public function _fetch($content, $strip_unused_tags = true) {
$ld = $this->get_left_delimiter();
$rd = $this->get_right_delimiter();
foreach($this->vars as $key => $value) {
$content = str_replace($ld.'$'.$key.$rd, $value, $content);
}
if ($strip_unused_tags) {
//striping unused var's placeholders
$content = ereg_replace($ld.'\$[a-zA-Z0-9_]+'.$rd, '', $content);
}
return $content;
}
/**
* Loads file specified by $tpl, parses it and returns it with all tags replaced with assigned values.
*
* @param string $tpl
* @return string
*/
public function fetch($tpl) {
$ret = false;
if (file_exists($this->get_tpl_dir().$tpl)) {
$content = file_get_contents($this->get_tpl_dir().$tpl);
$ret = $this->_fetch($content);
} else {
throw new TE_Tple_File_Not_Exists($this->get_tpl_dir().$tpl);
}
return $ret;
}
/**
* Assignes value to a key/tag.
* Will throw exception if $tpl_var does not conform ereg("[a-zA-Z0-9_]+"), i.e. is not alphanumeric (with optional underscore)
*
* @param string $tpl_var
* @param string $value
* @throws Tangra_Exception
*/
public function assign($tpl_var, $value = null) {
if ($this->check_tpl_var_name($tpl_var)) {
$this->vars[$tpl_var] = $value;
} else {
throw new Tangra_Exception('Variable name is not valid. $tpl_var = '.$tpl_var);
}
}
/**
* Assignes value to a key/tag. Similar to Tangra_Simple_Tple::assign() but will throw exception if there is already added value with the same key.
* Will throw exception if $tpl_var does not conform ereg("[a-zA-Z0-9_]+"), i.e. is not alphanumeric (with optional underscore)
*
* @param string $tpl_var key/tag name
* @param any $value
* @throws TE_Var_Already_Exists
*/
public function assign_strict($tpl_var, $value) {
if ($this->check_tpl_var_name($tpl_var)) {
if (!array_key_exists($tpl_var, $this->vars)) {
$this->vars[$tpl_var] = $value;
} else {
throw new TE_Var_Already_Exists('Variable "'.$tpl_var.'" already exists.');
}
} else {
throw new Tangra_Exception('Variable name is not valid. $tpl_var = '.$tpl_var);
}
}
/**
* Clears all asigments.
*
*/
public function clear_all_assigns() {
$this->vars = array();
}
/**
* Sets entire assigment array at once. Useful when array is loaded from file. Normally is not used by the users.
* Throws exception if parameter is not an array.
* @param unknown_type $vars_array
* @throws Tangra_Exception
*/
public function assign_set_array($vars_array) {
if (is_array($vars_array)) {
$this->vars = $vars_array;
} else {
throw new Tangra_Exception('$vars_array is not an array');
}
}
/**
* Sets template dir that will be used to compose the full path for the template file
*
* @param string $tpl_path
*/
public function set_tpl_dir($tpl_path) {
if ($tpl_path) {
if (file_exists($tpl_path)) {
$this->tpl_path = tangra_normalize_path($tpl_path);
} else {
throw new TE_Tple_Path_Not_Exists(tangra_normalize_path($tpl_path));
}
} else {
$this->tpl_path = tangra_normalize_path($tpl_path);
}
}
/**
* Gets template path
*
* @return string
*/
public function get_tpl_dir() {
return $this->tpl_path;
}
/**
* Sets left delimiter for the tags in the template
*
* @param string $left_delimiter
*/
public function set_left_delimiter($left_delimiter = '{@$') {
$this->left_delimiter = $left_delimiter;
}
/**
* Gets left delimiter for the tags in the template
*
* @param string $left_delimiter
*/
public function get_left_delimiter() {
return $this->left_delimiter;
}
/**
* Sets right delimiter for the tags in the template
*
* @return unknown
*/
public function set_right_delimiter($right_delimiter = '@}') {
$this->right_delimiter = $right_delimiter;
}
/**
* Gets right delimiter for the tags in the template
*
* @return unknown
*/
public function get_right_delimiter() {
return $this->right_delimiter;
}
/**
* Checks if $tpl_var is "valid" key identifier
*
* @param string $tpl_var
* @return boolean
* @access private
*/
private function check_tpl_var_name($tpl_var) {
$ret = false;
if (ereg( "[a-zA-Z0-9_]+", $tpl_var)) {
$ret = true;
}
return $ret;
}
}

Source for file tangra_simple_tple.class.php