tests/PHPUnit/Util/Template.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2009, Sebastian Bergmann <sb@sebastian-bergmann.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   Testing
  38  * @package    PHPUnit
  39  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  40  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42
  43  * @link       http://www.phpunit.de/
  44  * @since      File available since Release 3.0.0
  45  */
  46
  47 require_once 'PHPUnit/Util/Filter.php';
  48
  49 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  50
  51 /**
  52  *
  53  *
  54  * @category   Testing
  55  * @package    PHPUnit
  56  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  57  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  58  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  59  * @version    Release: 3.3.17
  60  * @link       http://www.phpunit.de/
  61  * @since      Class available since Release 3.0.0
  62  */
  63 class PHPUnit_Util_Template
  64 {
  65     /**
  66      * @var    string
  67      */
  68     protected static $date = '';
  69
  70     /**
  71      * @var    string
  72      */
  73     protected $template = '';
  74
  75     /**
  76      * @var    array
  77      */
  78     protected $values = array();
  79
  80     /**
  81      * Constructor.
  82      *
  83      * @param  string $file
  84      * @throws InvalidArgumentException
  85      */
  86     public function __construct($file = '')
  87     {
  88         $this->setFile($file);
  89     }
  90
  91     /**
  92      * Sets the template file.
  93      *
  94      * @param  string $file
  95      * @throws InvalidArgumentException
  96      */
  97     public function setFile($file)
  98     {
  99         $distFile = $file . '.dist';
 100
 101         if (file_exists($file)) {
 102             $this->template = file_get_contents($file);
 103         }
 104
 105         else if (file_exists($distFile)) {
 106             $this->template = file_get_contents($distFile);
 107         }
 108
 109         else {
 110             throw new InvalidArgumentException(
 111               'Template file could not be loaded.'
 112             );
 113         }
 114     }
 115
 116     /**
 117      * Sets one or more template variables.
 118      *
 119      * @param  array   $values
 120      * @param  boolean $merge
 121      */
 122     public function setVar(array $values, $merge = TRUE)
 123     {
 124         if (!$merge || empty($this->values)) {
 125             $this->values = $values;
 126         } else {
 127             $this->values = array_merge($this->values, $values);
 128         }
 129     }
 130
 131     /**
 132      * Renders the template and returns the result.
 133      *
 134      * @return string
 135      */
 136     public function render()
 137     {
 138         $keys = array();
 139
 140         foreach ($this->values as $key => $value) {
 141             $keys[] = '{' . $key . '}';
 142         }
 143
 144         return str_replace($keys, $this->values, $this->template);
 145     }
 146
 147     /**
 148      * Renders the template and writes the result to a file.
 149      *
 150      * @param string $target
 151      */
 152     public function renderTo($target)
 153     {
 154         $fp = @fopen($target, 'wt');
 155
 156         if ($fp) {
 157             fwrite($fp, $this->render());
 158             fclose($fp);
 159         } else {
 160             throw new RuntimeException('Could not write to ' . $target . '.');
 161         }
 162     }
 163
 164     /**
 165      * Returns the cached result of date('D M j G:i:s T Y').
 166      *
 167      * @return string
 168      * @since  Method available since Release 3.0.1
 169      */
 170     public static function getDate()
 171     {
 172         if (self::$date == '') {
 173             self::$date = date('D M j G:i:s T Y');
 174         }
 175
 176         return self::$date;
 177     }
 178 }
 179 ?>