class PHPUnit_Framework_Constraint_Attribute in Zircon Profile 8

@since Class available since Release 3.1.0

Hierarchy

• class \PHPUnit_Framework_Constraint implements \Countable, PHPUnit_Framework_SelfDescribing
  • class \PHPUnit_Framework_Constraint_Composite
    • class \PHPUnit_Framework_Constraint_Attribute

File

vendor/phpunit/phpunit/src/Framework/Constraint/Attribute.php, line 14

class PHPUnit_Framework_Constraint_Attribute extends PHPUnit_Framework_Constraint_Composite {

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

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

  /**
   * Evaluates the constraint for parameter $other
   *
   * If $returnResult is set to false (the default), an exception is thrown
   * in case of a failure. null is returned otherwise.
   *
   * If $returnResult is true, the result of the evaluation is returned as
   * a boolean value instead: true in case of success, false in case of a
   * failure.
   *
   * @param  mixed                                        $other        Value or object to evaluate.
   * @param  string                                       $description  Additional information about the test
   * @param  bool                                         $returnResult Whether to return a result or throw an exception
   * @return mixed
   * @throws PHPUnit_Framework_ExpectationFailedException
   */
  public function evaluate($other, $description = '', $returnResult = false) {
    return parent::evaluate(PHPUnit_Framework_Assert::readAttribute($other, $this->attributeName), $description, $returnResult);
  }

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

  /**
   * 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 $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::fail	protected	function	Throws an exception for the given compared value and test description
PHPUnit_Framework_Constraint::matches	protected	function	Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.	25
PHPUnit_Framework_Constraint_Attribute::$attributeName	protected	property
PHPUnit_Framework_Constraint_Attribute::evaluate	public	function	Evaluates the constraint for parameter $other Overrides PHPUnit_Framework_Constraint_Composite::evaluate
PHPUnit_Framework_Constraint_Attribute::failureDescription	protected	function	Returns the description of the failure Overrides PHPUnit_Framework_Constraint::failureDescription
PHPUnit_Framework_Constraint_Attribute::toString	public	function	Returns a string representation of the constraint. Overrides PHPUnit_Framework_SelfDescribing::toString
PHPUnit_Framework_Constraint_Attribute::__construct	public	function	Overrides PHPUnit_Framework_Constraint_Composite::__construct
PHPUnit_Framework_Constraint_Composite::$innerConstraint	protected	property
PHPUnit_Framework_Constraint_Composite::count	public	function	Counts the number of constraint elements. Overrides PHPUnit_Framework_Constraint::count