- \PHPUnit_Framework_Constraint
- \PHPUnit_Framework_Constraint_Composite
- \PHPUnit_Framework_Constraint_Attribute
- \PHPUnit_Framework_Constraint_Composite
class (none) \ PHPUnit_Framework_Constraint_Attribute
- All implemented interfaces:
- Countable, PHPUnit_Framework_SelfDescribing
Abstract base class for constraints. which are placed upon any value. (from PHPUnit_Framework_Constraint)
Method Summary
| Name | Description |
|---|---|
| __construct(PHPUnit_Framework_Constraint $constraint, $attributeName) | |
| evaluate($other, $description = "", $returnResult = false) | Evaluates the constraint for parameter $other |
| failureDescription($other) | Returns the description of the failure |
| toString() | Returns a string representation of the constraint. |
Inherited Method Summary
| Name | Description |
|---|---|
| additionalFailureDescription($other) | Return additional failure description where needed (from PHPUnit_Framework_Constraint) |
| count() | Counts the number of constraint elements. (from PHPUnit_Framework_Constraint_Composite) |
| fail($other, $description, ComparisonFailure $comparisonFailure = null) | Throws an exception for the given compared value and test description (from PHPUnit_Framework_Constraint) |
| matches($other) | Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise. (from PHPUnit_Framework_Constraint) |
public function __construct(PHPUnit_Framework_Constraint $constraint, $attributeName)
- Overrides:
- __construct()
- Parameters:
PHPUnit_Framework_Constraint- $constraintstring- $attributeName
public function evaluate($other, $description = "", $returnResult = false)
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.
- Overrides:
- evaluate($other, $description = "", $returnResult = false)
- Parameters:
mixed- $other Value or object to evaluate.string- $description Additional information about the testbool- $returnResult Whether to return a result or throw an exception- Defaults:
description=""returnResult=false- Returns:
- mixed
- Throws:
- PHPUnit_Framework_ExpectationFailedException
protected function failureDescription($other)
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.
- Overrides:
- failureDescription($other)
- Parameters:
mixed- $other Evaluated value or object.- Returns:
- string
public function toString()
Returns a string representation of the constraint.
- Returns:
- string