tests/PHPUnit/PHPUnit/Util/Filesystem.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 3.0.0
  44  */
  45
  46 /**
  47  * Filesystem helpers.
  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 3.0.0
  57  */
  58 class PHPUnit_Util_Filesystem
  59 {
  60     /**
  61      * @var array
  62      */
  63     protected static $buffer = array();
  64
  65     /**
  66      * Maps class names to source file names:
  67      *   - PEAR CS:   Foo_Bar_Baz -> Foo/Bar/Baz.php
  68      *   - Namespace: Foo\Bar\Baz -> Foo/Bar/Baz.php
  69      *
  70      * @param  string $className
  71      * @return string
  72      * @since  Method available since Release 3.4.0
  73      */
  74     public static function classNameToFilename($className)
  75     {
  76         return str_replace(
  77           array('_', '\\'),
  78           DIRECTORY_SEPARATOR,
  79           $className
  80         ) . '.php';
  81     }
  82
  83     /**
  84      * Starts the collection of loaded files.
  85      *
  86      * @since  Method available since Release 3.3.0
  87      */
  88     public static function collectStart()
  89     {
  90         self::$buffer = get_included_files();
  91     }
  92
  93     /**
  94      * Stops the collection of loaded files and
  95      * returns the names of the loaded files.
  96      *
  97      * @return array
  98      * @since  Method available since Release 3.3.0
  99      */
 100     public static function collectEnd()
 101     {
 102         return array_values(
 103           array_diff(get_included_files(), self::$buffer)
 104         );
 105     }
 106
 107     /**
 108      * Stops the collection of loaded files and adds
 109      * the names of the loaded files to the blacklist.
 110      *
 111      * @return array
 112      * @since  Method available since Release 3.4.6
 113      */
 114     public static function collectEndAndAddToBlacklist()
 115     {
 116         foreach (self::collectEnd() as $blacklistedFile) {
 117             PHP_CodeCoverage_Filter::getInstance()->addFileToBlacklist(
 118               $blacklistedFile, 'PHPUNIT'
 119             );
 120         }
 121     }
 122
 123     /**
 124      * Wrapper for file_exists() that searches the include_path.
 125      *
 126      * @param  string $file
 127      * @return mixed
 128      * @author Mattis Stordalen Flister <mattis@xait.no>
 129      * @since  Method available since Release 3.2.9
 130      */
 131     public static function fileExistsInIncludePath($file)
 132     {
 133         if (file_exists($file)) {
 134             return realpath($file);
 135         }
 136
 137         $paths = explode(PATH_SEPARATOR, get_include_path());
 138
 139         foreach ($paths as $path) {
 140             $fullpath = $path . DIRECTORY_SEPARATOR . $file;
 141
 142             if (file_exists($fullpath)) {
 143                 return realpath($fullpath);
 144             }
 145         }
 146
 147         return FALSE;
 148     }
 149 }