No Description

Template.php 5.0KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178
  1. <?php
  2. /**
  3. * Text_Template
  4. *
  5. * Copyright (c) 2009-2014, Sebastian Bergmann <sebastian@phpunit.de>.
  6. * All rights reserved.
  7. *
  8. * Redistribution and use in source and binary forms, with or without
  9. * modification, are permitted provided that the following conditions
  10. * are met:
  11. *
  12. * * Redistributions of source code must retain the above copyright
  13. * notice, this list of conditions and the following disclaimer.
  14. *
  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
  18. * distribution.
  19. *
  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.
  23. *
  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.
  36. *
  37. * @category Text
  38. * @package Template
  39. * @author Sebastian Bergmann <sebastian@phpunit.de>
  40. * @copyright 2009-2014 Sebastian Bergmann <sebastian@phpunit.de>
  41. * @license http://www.opensource.org/licenses/BSD-3-Clause The BSD 3-Clause License
  42. * @link http://github.com/sebastianbergmann/php-text-template
  43. * @since File available since Release 1.0.0
  44. */
  45. /**
  46. * A simple template engine.
  47. *
  48. * @category Text
  49. * @package Template
  50. * @author Sebastian Bergmann <sebastian@phpunit.de>
  51. * @copyright 2009-2014 Sebastian Bergmann <sebastian@phpunit.de>
  52. * @license http://www.opensource.org/licenses/BSD-3-Clause The BSD 3-Clause License
  53. * @version Release: @package_version@
  54. * @link http://github.com/sebastianbergmann/php-text-template
  55. * @since Class available since Release 1.0.0
  56. */
  57. class Text_Template
  58. {
  59. /**
  60. * @var string
  61. */
  62. protected $template = '';
  63. /**
  64. * @var string
  65. */
  66. protected $openDelimiter = '{';
  67. /**
  68. * @var string
  69. */
  70. protected $closeDelimiter = '}';
  71. /**
  72. * @var array
  73. */
  74. protected $values = array();
  75. /**
  76. * Constructor.
  77. *
  78. * @param string $file
  79. * @throws InvalidArgumentException
  80. */
  81. public function __construct($file = '', $openDelimiter = '{', $closeDelimiter = '}')
  82. {
  83. $this->setFile($file);
  84. $this->openDelimiter = $openDelimiter;
  85. $this->closeDelimiter = $closeDelimiter;
  86. }
  87. /**
  88. * Sets the template file.
  89. *
  90. * @param string $file
  91. * @throws InvalidArgumentException
  92. */
  93. public function setFile($file)
  94. {
  95. $distFile = $file . '.dist';
  96. if (file_exists($file)) {
  97. $this->template = file_get_contents($file);
  98. }
  99. else if (file_exists($distFile)) {
  100. $this->template = file_get_contents($distFile);
  101. }
  102. else {
  103. throw new InvalidArgumentException(
  104. 'Template file could not be loaded.'
  105. );
  106. }
  107. }
  108. /**
  109. * Sets one or more template variables.
  110. *
  111. * @param array $values
  112. * @param boolean $merge
  113. */
  114. public function setVar(array $values, $merge = TRUE)
  115. {
  116. if (!$merge || empty($this->values)) {
  117. $this->values = $values;
  118. } else {
  119. $this->values = array_merge($this->values, $values);
  120. }
  121. }
  122. /**
  123. * Renders the template and returns the result.
  124. *
  125. * @return string
  126. */
  127. public function render()
  128. {
  129. $keys = array();
  130. foreach ($this->values as $key => $value) {
  131. $keys[] = $this->openDelimiter . $key . $this->closeDelimiter;
  132. }
  133. return str_replace($keys, $this->values, $this->template);
  134. }
  135. /**
  136. * Renders the template and writes the result to a file.
  137. *
  138. * @param string $target
  139. */
  140. public function renderTo($target)
  141. {
  142. $fp = @fopen($target, 'wt');
  143. if ($fp) {
  144. fwrite($fp, $this->render());
  145. fclose($fp);
  146. } else {
  147. $error = error_get_last();
  148. throw new RuntimeException(
  149. sprintf(
  150. 'Could not write to %s: %s',
  151. $target,
  152. substr(
  153. $error['message'],
  154. strpos($error['message'], ':') + 2
  155. )
  156. )
  157. );
  158. }
  159. }
  160. }