5 * Copyright (c) 2009-2010, Sebastian Bergmann <sb@sebastian-bergmann.de>.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * * Neither the name of Sebastian Bergmann nor the names of his
21 * contributors may be used to endorse or promote products derived
22 * from this software without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
27 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
28 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
29 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
30 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
31 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
34 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 * POSSIBILITY OF SUCH DAMAGE.
39 * @author Sebastian Bergmann <sb@sebastian-bergmann.de>
40 * @copyright 2009-2010 Sebastian Bergmann <sb@sebastian-bergmann.de>
41 * @license http://www.opensource.org/licenses/bsd-license.php BSD License
42 * @link http://github.com/sebastianbergmann/php-text-template
43 * @since File available since Release 1.0.0
47 * A simple template engine.
51 * @author Sebastian Bergmann <sb@sebastian-bergmann.de>
52 * @copyright 2009-2010 Sebastian Bergmann <sb@sebastian-bergmann.de>
53 * @license http://www.opensource.org/licenses/bsd-license.php BSD License
54 * @version Release: 1.1.0
55 * @link http://github.com/sebastianbergmann/php-text-template
56 * @since Class available since Release 1.0.0
63 protected $template = '';
68 protected $values = array();
74 * @throws InvalidArgumentException
76 public function __construct($file = '')
78 $this->setFile($file);
82 * Sets the template file.
85 * @throws InvalidArgumentException
87 public function setFile($file)
89 $distFile = $file . '.dist';
91 if (file_exists($file)) {
92 $this->template = file_get_contents($file);
95 else if (file_exists($distFile)) {
96 $this->template = file_get_contents($distFile);
100 throw new InvalidArgumentException(
101 'Template file could not be loaded.'
107 * Sets one or more template variables.
109 * @param array $values
110 * @param boolean $merge
112 public function setVar(array $values, $merge = TRUE)
114 if (!$merge || empty($this->values)) {
115 $this->values = $values;
117 $this->values = array_merge($this->values, $values);
122 * Renders the template and returns the result.
126 public function render()
130 foreach ($this->values as $key => $value) {
131 $keys[] = '{' . $key . '}';
134 return str_replace($keys, $this->values, $this->template);
138 * Renders the template and writes the result to a file.
140 * @param string $target
142 public function renderTo($target)
144 $fp = @fopen($target, 'wt');
147 fwrite($fp, $this->render());
150 throw new RuntimeException('Could not write to ' . $target . '.');