class PHPUnit_Framework_Constraint_ClassHasAttribute in Zircon Profile 8

Constraint that asserts that the class it is evaluated for has a given attribute.

The attribute name is passed in the constructor.

@since Class available since Release 3.1.0

Hierarchy

• class \PHPUnit_Framework_Constraint implements \Countable, PHPUnit_Framework_SelfDescribing
  • class \PHPUnit_Framework_Constraint_ClassHasAttribute

File

vendor/phpunit/phpunit/src/Framework/Constraint/ClassHasAttribute.php, line 19

class PHPUnit_Framework_Constraint_ClassHasAttribute extends PHPUnit_Framework_Constraint {

  /**
   * @var string
   */
  protected $attributeName;

  /**
   * @param string $attributeName
   */
  public function __construct($attributeName) {
    parent::__construct();
    $this->attributeName = $attributeName;
  }

  /**
   * Evaluates the constraint for parameter $other. Returns true if the
   * constraint is met, false otherwise.
   *
   * @param  mixed $other Value or object to evaluate.
   * @return bool
   */
  protected function matches($other) {
    $class = new ReflectionClass($other);
    return $class
      ->hasProperty($this->attributeName);
  }

  /**
   * Returns a string representation of the constraint.
   *
   * @return string
   */
  public function toString() {
    return sprintf('has attribute "%s"', $this->attributeName);
  }

  /**
   * Returns the description of the failure
   *
   * The beginning of failure messages is "Failed asserting that" in most
   * cases. This method should return the second part of that sentence.
   *
   * @param  mixed  $other Evaluated value or object.
   * @return string
   */
  protected function failureDescription($other) {
    return sprintf('%sclass "%s" %s', is_object($other) ? 'object of ' : '', is_object($other) ? get_class($other) : $other, $this
      ->toString());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PHPUnit_Framework_Constraint::$exporter	protected	property
PHPUnit_Framework_Constraint::additionalFailureDescription	protected	function	Return additional failure description where needed	1
PHPUnit_Framework_Constraint::count	public	function	Counts the number of constraint elements.	6
PHPUnit_Framework_Constraint::evaluate	public	function	Evaluates the constraint for parameter $other	9
PHPUnit_Framework_Constraint::fail	protected	function	Throws an exception for the given compared value and test description
PHPUnit_Framework_Constraint_ClassHasAttribute::$attributeName	protected	property
PHPUnit_Framework_Constraint_ClassHasAttribute::failureDescription	protected	function	Returns the description of the failure Overrides PHPUnit_Framework_Constraint::failureDescription
PHPUnit_Framework_Constraint_ClassHasAttribute::matches	protected	function	Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise. Overrides PHPUnit_Framework_Constraint::matches	2
PHPUnit_Framework_Constraint_ClassHasAttribute::toString	public	function	Returns a string representation of the constraint. Overrides PHPUnit_Framework_SelfDescribing::toString	1
PHPUnit_Framework_Constraint_ClassHasAttribute::__construct	public	function	Overrides PHPUnit_Framework_Constraint::__construct