A simple template engine.
@category Text @package Template @author Sebastian Bergmann <sb@sebastian-bergmann.de> @copyright 2009-2012 Sebastian Bergmann <sb@sebastian-bergmann.de> @license http://www.opensource.org/licenses/BSD-3-Clause The BSD 3-Clause License @version Release: @package_version@ @link http://github.com/sebastianbergmann/php-text-template @since Class available since Release 1.0.0
Expanded class hierarchy of Text_Template
class Text_Template {
/**
* @var string
*/
protected $template = '';
/**
* @var array
*/
protected $values = array();
/**
* Constructor.
*
* @param string $file
* @throws InvalidArgumentException
*/
public function __construct($file = '') {
$this
->setFile($file);
}
/**
* Sets the template file.
*
* @param string $file
* @throws InvalidArgumentException
*/
public function setFile($file) {
$distFile = $file . '.dist';
if (file_exists($file)) {
$this->template = file_get_contents($file);
}
else {
if (file_exists($distFile)) {
$this->template = file_get_contents($distFile);
}
else {
throw new InvalidArgumentException('Template file could not be loaded.');
}
}
}
/**
* Sets one or more template variables.
*
* @param array $values
* @param boolean $merge
*/
public function setVar(array $values, $merge = TRUE) {
if (!$merge || empty($this->values)) {
$this->values = $values;
}
else {
$this->values = array_merge($this->values, $values);
}
}
/**
* Renders the template and returns the result.
*
* @return string
*/
public function render() {
$keys = array();
foreach ($this->values as $key => $value) {
$keys[] = '{' . $key . '}';
}
return str_replace($keys, $this->values, $this->template);
}
/**
* Renders the template and writes the result to a file.
*
* @param string $target
*/
public function renderTo($target) {
$fp = @fopen($target, 'wt');
if ($fp) {
fwrite($fp, $this
->render());
fclose($fp);
}
else {
$error = error_get_last();
throw new RuntimeException(sprintf('Could not write to %s: %s', $target, substr($error['message'], strpos($error['message'], ':') + 2)));
}
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Text_Template:: |
protected | property | ||
Text_Template:: |
protected | property | ||
Text_Template:: |
public | function | Renders the template and returns the result. | |
Text_Template:: |
public | function | Renders the template and writes the result to a file. | |
Text_Template:: |
public | function | Sets the template file. | |
Text_Template:: |
public | function | Sets one or more template variables. | |
Text_Template:: |
public | function | Constructor. |