class Blacklist in Zircon Profile 8

A blacklist for global state elements that should not be snapshotted.

@author Sebastian Bergmann <[e-mail]> @copyright 2001-2014 Sebastian Bergmann <[e-mail]> @license http://www.opensource.org/licenses/BSD-3-Clause The BSD 3-Clause License @link http://www.github.com/sebastianbergmann/global-state

Hierarchy

• class \SebastianBergmann\GlobalState\Blacklist

1 file declares its use of Blacklist

TestCase.php in vendor/phpunit/phpunit/src/Framework/TestCase.php

File

vendor/sebastian/global-state/src/Blacklist.php, line 55

Namespace

SebastianBergmann\GlobalState

class Blacklist {

  /**
   * @var array
   */
  private $globalVariables = array();

  /**
   * @var array
   */
  private $classes = array();

  /**
   * @var array
   */
  private $classNamePrefixes = array();

  /**
   * @var array
   */
  private $parentClasses = array();

  /**
   * @var array
   */
  private $interfaces = array();

  /**
   * @var array
   */
  private $staticAttributes = array();

  /**
   * @param string $variableName
   */
  public function addGlobalVariable($variableName) {
    $this->globalVariables[$variableName] = true;
  }

  /**
   * @param string $className
   */
  public function addClass($className) {
    $this->classes[] = $className;
  }

  /**
   * @param string $className
   */
  public function addSubclassesOf($className) {
    $this->parentClasses[] = $className;
  }

  /**
   * @param string $interfaceName
   */
  public function addImplementorsOf($interfaceName) {
    $this->interfaces[] = $interfaceName;
  }

  /**
   * @param string $classNamePrefix
   */
  public function addClassNamePrefix($classNamePrefix) {
    $this->classNamePrefixes[] = $classNamePrefix;
  }

  /**
   * @param string $className
   * @param string $attributeName
   */
  public function addStaticAttribute($className, $attributeName) {
    if (!isset($this->staticAttributes[$className])) {
      $this->staticAttributes[$className] = array();
    }
    $this->staticAttributes[$className][$attributeName] = true;
  }

  /**
   * @param  string $variableName
   * @return boolean
   */
  public function isGlobalVariableBlacklisted($variableName) {
    return isset($this->globalVariables[$variableName]);
  }

  /**
   * @param  string $className
   * @param  string $attributeName
   * @return boolean
   */
  public function isStaticAttributeBlacklisted($className, $attributeName) {
    if (in_array($className, $this->classes)) {
      return true;
    }
    foreach ($this->classNamePrefixes as $prefix) {
      if (strpos($className, $prefix) === 0) {
        return true;
      }
    }
    $class = new ReflectionClass($className);
    foreach ($this->parentClasses as $type) {
      if ($class
        ->isSubclassOf($type)) {
        return true;
      }
    }
    foreach ($this->interfaces as $type) {
      if ($class
        ->implementsInterface($type)) {
        return true;
      }
    }
    if (isset($this->staticAttributes[$className][$attributeName])) {
      return true;
    }
    return false;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Blacklist::$classes	private	property
Blacklist::$classNamePrefixes	private	property
Blacklist::$globalVariables	private	property
Blacklist::$interfaces	private	property
Blacklist::$parentClasses	private	property
Blacklist::$staticAttributes	private	property
Blacklist::addClass	public	function
Blacklist::addClassNamePrefix	public	function
Blacklist::addGlobalVariable	public	function
Blacklist::addImplementorsOf	public	function
Blacklist::addStaticAttribute	public	function
Blacklist::addSubclassesOf	public	function
Blacklist::isGlobalVariableBlacklisted	public	function
Blacklist::isStaticAttributeBlacklisted	public	function