PHPUnit_Framework_Constraint_StringContains
extends PHPUnit_Framework_Constraint
in package
Constraint that asserts that the string it is evaluated for contains a given string.
Uses strpos() to find the position of the string in the input, if not found the evaluation fails.
The sub-string is passed in the constructor.
Tags
Table of Contents
- $exporter : mixed
- $ignoreCase : bool
- $string : string
- __construct() : mixed
- count() : int
- Counts the number of constraint elements.
- evaluate() : mixed
- Evaluates the constraint for parameter $other
- toString() : string
- Returns a string representation of the constraint.
- additionalFailureDescription() : string
- Return additional failure description where needed
- fail() : mixed
- Throws an exception for the given compared value and test description
- failureDescription() : string
- Returns the description of the failure
- matches() : bool
- Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.
Properties
$exporter
protected
mixed
$exporter
$ignoreCase
protected
bool
$ignoreCase
$string
protected
string
$string
Methods
__construct()
public
__construct(string $string[, bool $ignoreCase = false ]) : mixed
Parameters
- $string : string
- $ignoreCase : bool = false
Return values
mixed —count()
Counts the number of constraint elements.
public
count() : int
Tags
Return values
int —evaluate()
Evaluates the constraint for parameter $other
public
evaluate(mixed $other[, string $description = '' ][, bool $returnResult = false ]) : mixed
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.
Parameters
- $other : mixed
-
Value or object to evaluate.
- $description : string = ''
-
Additional information about the test
- $returnResult : bool = false
-
Whether to return a result or throw an exception
Tags
Return values
mixed —toString()
Returns a string representation of the constraint.
public
toString() : string
Return values
string —additionalFailureDescription()
Return additional failure description where needed
protected
additionalFailureDescription(mixed $other) : string
The function can be overridden to provide additional failure information like a diff
Parameters
- $other : mixed
-
Evaluated value or object.
Return values
string —fail()
Throws an exception for the given compared value and test description
protected
fail(mixed $other, string $description[, ComparisonFailure $comparisonFailure = null ]) : mixed
Parameters
- $other : mixed
-
Evaluated value or object.
- $description : string
-
Additional information about the test
- $comparisonFailure : ComparisonFailure = null
Tags
Return values
mixed —failureDescription()
Returns the description of the failure
protected
failureDescription(mixed $other) : string
The beginning of failure messages is "Failed asserting that" in most cases. This method should return the second part of that sentence.
To provide additional failure information additionalFailureDescription can be used.
Parameters
- $other : mixed
-
Evaluated value or object.
Return values
string —matches()
Evaluates the constraint for parameter $other. Returns true if the constraint is met, false otherwise.
protected
matches(mixed $other) : bool
Parameters
- $other : mixed
-
Value or object to evaluate.