123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178 |
- <?php
- /**
- * Text_Template
- *
- * Copyright (c) 2009-2014, Sebastian Bergmann <sebastian@phpunit.de>.
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * * Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- *
- * * Neither the name of Sebastian Bergmann nor the names of his
- * contributors may be used to endorse or promote products derived
- * from this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
- * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
- * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
- * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
- * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
- * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
- *
- * @category Text
- * @package Template
- * @author Sebastian Bergmann <sebastian@phpunit.de>
- * @copyright 2009-2014 Sebastian Bergmann <sebastian@phpunit.de>
- * @license http://www.opensource.org/licenses/BSD-3-Clause The BSD 3-Clause License
- * @link http://github.com/sebastianbergmann/php-text-template
- * @since File available since Release 1.0.0
- */
- /**
- * A simple template engine.
- *
- * @category Text
- * @package Template
- * @author Sebastian Bergmann <sebastian@phpunit.de>
- * @copyright 2009-2014 Sebastian Bergmann <sebastian@phpunit.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
- */
- class Text_Template
- {
- /**
- * @var string
- */
- protected $template = '';
- /**
- * @var string
- */
- protected $openDelimiter = '{';
- /**
- * @var string
- */
- protected $closeDelimiter = '}';
- /**
- * @var array
- */
- protected $values = array();
- /**
- * Constructor.
- *
- * @param string $file
- * @throws InvalidArgumentException
- */
- public function __construct($file = '', $openDelimiter = '{', $closeDelimiter = '}')
- {
- $this->setFile($file);
- $this->openDelimiter = $openDelimiter;
- $this->closeDelimiter = $closeDelimiter;
- }
- /**
- * 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[] = $this->openDelimiter . $key . $this->closeDelimiter;
- }
- 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
- )
- )
- );
- }
- }
- }
|