class PHPUnit_Util_Blacklist in Zircon Profile 8

Utility class for blacklisting PHPUnit's own source code files.

@since Class available since Release 4.0.0

Hierarchy

• class \PHPUnit_Util_Blacklist

File

vendor/phpunit/phpunit/src/Util/Blacklist.php, line 16

class PHPUnit_Util_Blacklist {

  /**
   * @var array
   */
  public static $blacklistedClassNames = array(
    'File_Iterator' => 1,
    'PHP_CodeCoverage' => 1,
    'PHP_Invoker' => 1,
    'PHP_Timer' => 1,
    'PHP_Token' => 1,
    'PHPUnit_Framework_TestCase' => 2,
    'PHPUnit_Extensions_Database_TestCase' => 2,
    'PHPUnit_Framework_MockObject_Generator' => 2,
    'PHPUnit_Extensions_SeleniumTestCase' => 2,
    'Text_Template' => 1,
    'Symfony\\Component\\Yaml\\Yaml' => 1,
    'SebastianBergmann\\Diff\\Diff' => 1,
    'SebastianBergmann\\Environment\\Runtime' => 1,
    'SebastianBergmann\\Comparator\\Comparator' => 1,
    'SebastianBergmann\\Exporter\\Exporter' => 1,
    'SebastianBergmann\\GlobalState\\Snapshot' => 1,
    'SebastianBergmann\\RecursionContext\\Context' => 1,
    'SebastianBergmann\\Version' => 1,
    'Composer\\Autoload\\ClassLoader' => 1,
    'Doctrine\\Instantiator\\Instantiator' => 1,
    'phpDocumentor\\Reflection\\DocBlock' => 1,
    'Prophecy\\Prophet' => 1,
  );

  /**
   * @var array
   */
  private static $directories;

  /**
   * @return array
   * @since  Method available since Release 4.1.0
   */
  public function getBlacklistedDirectories() {
    $this
      ->initialize();
    return self::$directories;
  }

  /**
   * @param  string $file
   * @return bool
   */
  public function isBlacklisted($file) {
    if (defined('PHPUNIT_TESTSUITE')) {
      return false;
    }
    $this
      ->initialize();
    foreach (self::$directories as $directory) {
      if (strpos($file, $directory) === 0) {
        return true;
      }
    }
    return false;
  }
  private function initialize() {
    if (self::$directories === null) {
      self::$directories = array();
      foreach (self::$blacklistedClassNames as $className => $parent) {
        if (!class_exists($className)) {
          continue;
        }
        $reflector = new ReflectionClass($className);
        $directory = $reflector
          ->getFileName();
        for ($i = 0; $i < $parent; $i++) {
          $directory = dirname($directory);
        }
        self::$directories[] = $directory;
      }

      // Hide process isolation workaround on Windows.
      // @see PHPUnit_Util_PHP::factory()
      // @see PHPUnit_Util_PHP_Windows::process()
      if (DIRECTORY_SEPARATOR === '\\') {

        // tempnam() prefix is limited to first 3 chars.
        // @see http://php.net/manual/en/function.tempnam.php
        self::$directories[] = sys_get_temp_dir() . '\\PHP';
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PHPUnit_Util_Blacklist::$blacklistedClassNames	public static	property
PHPUnit_Util_Blacklist::$directories	private static	property
PHPUnit_Util_Blacklist::getBlacklistedDirectories	public	function	@since Method available since Release 4.1.0
PHPUnit_Util_Blacklist::initialize	private	function
PHPUnit_Util_Blacklist::isBlacklisted	public	function