tests/PHPUnit/PHPUnit/Util/Skeleton.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2011, 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  * @package    PHPUnit
  38  * @subpackage Util
  39  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  40  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42  * @link       http://www.phpunit.de/
  43  * @since      File available since Release 2.1.0
  44  */
  45
  46 /**
  47  * Generator for skeletons.
  48  *
  49  * @package    PHPUnit
  50  * @subpackage Util
  51  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  52  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  53  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  54  * @version    Release: 3.5.13
  55  * @link       http://www.phpunit.de/
  56  * @since      Class available since Release 2.1.0
  57  */
  58 abstract class PHPUnit_Util_Skeleton
  59 {
  60     /**
  61      * @var array
  62      */
  63     protected $inClassName;
  64
  65     /**
  66      * @var string
  67      */
  68     protected $inSourceFile;
  69
  70     /**
  71      * @var array
  72      */
  73     protected $outClassName;
  74
  75     /**
  76      * @var string
  77      */
  78     protected $outSourceFile;
  79
  80     /**
  81      * Constructor.
  82      *
  83      * @param string $inClassName
  84      * @param string $inSourceFile
  85      * @param string $outClassName
  86      * @param string $outSourceFile
  87      * @since Method available since Release 3.4.0
  88      */
  89     public function __construct($inClassName, $inSourceFile = '', $outClassName = '', $outSourceFile = '')
  90     {
  91         $this->inClassName = PHPUnit_Util_Class::parseFullyQualifiedClassName(
  92           $inClassName
  93         );
  94
  95         $this->outClassName = PHPUnit_Util_Class::parseFullyQualifiedClassName(
  96           $outClassName
  97         );
  98
  99         $this->inSourceFile = str_replace(
 100           $this->inClassName['fullyQualifiedClassName'],
 101           $this->inClassName['className'],
 102           $inSourceFile
 103         );
 104
 105         $this->outSourceFile = str_replace(
 106           $this->outClassName['fullyQualifiedClassName'],
 107           $this->outClassName['className'],
 108           $outSourceFile
 109         );
 110     }
 111
 112     /**
 113      * @return string
 114      */
 115     public function getOutClassName()
 116     {
 117         return $this->outClassName['fullyQualifiedClassName'];
 118     }
 119
 120     /**
 121      * @return string
 122      */
 123     public function getOutSourceFile()
 124     {
 125         return $this->outSourceFile;
 126     }
 127
 128     /**
 129      * Generates the code and writes it to a source file.
 130      *
 131      * @param  string  $file
 132      */
 133     public function write($file = '')
 134     {
 135         if ($file == '') {
 136             $file = $this->outSourceFile;
 137         }
 138
 139         if ($fp = @fopen($file, 'wt')) {
 140             @fwrite($fp, $this->generate());
 141             @fclose($fp);
 142         }
 143     }
 144
 145     abstract public function generate();
 146 }