- \PHPUnit_Framework_Constraint
- \PHPUnit_Framework_Constraint_TraversableContains
class (none) \ PHPUnit_Framework_Constraint_TraversableContains
- All implemented interfaces:
- Countable, PHPUnit_Framework_SelfDescribing
Constraint that asserts that the Traversable it is applied to contains a given value.
Method Summary
| Name | Description |
|---|---|
| __construct($value, $checkForObjectIdentity = true, $checkForNonObjectIdentity = false) | |
| failureDescription($other) | Returns the description of the failure |
| matches($other) | Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise. |
| 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) |
| evaluate($other, $description = "", $returnResult = false) | Evaluates the constraint for parameter $other (from PHPUnit_Framework_Constraint) |
| fail($other, $description, ComparisonFailure $comparisonFailure = null) | Throws an exception for the given compared value and test description (from PHPUnit_Framework_Constraint) |
public function __construct($value, $checkForObjectIdentity = true, $checkForNonObjectIdentity = false)
- Overrides:
- __construct()
- Parameters:
mixed- $valueboolean- $checkForNonObjectIdentity- Defaults:
checkForObjectIdentity=truecheckForNonObjectIdentity=false- Throws:
- PHPUnit_Framework_Exception
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
protected function matches($other)
Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.
This method can be overridden to implement the evaluation algorithm. (from matches)
- Overrides:
- matches($other)
- Parameters:
mixed- $other Value or object to evaluate.- Returns:
- bool
public function toString()
Returns a string representation of the constraint.
- Returns:
- string