Class HeaderContains
HeaderContains
Property Summary
-
$headerName protected
string -
$response protected
Psr\Http\Message\ResponseInterface
Method Summary
-
__construct() public
Constructor.
-
_getBodyAsString() protected
Get the response body as string
-
additionalFailureDescription() protected
Return additional failure description where needed.
-
count() public
Counts the number of constraint elements.
-
evaluate() public
Evaluates the constraint for parameter $other.
-
exporter() protected
-
fail() protected
Throws an exception for the given compared value and test description.
-
failureDescription() protected
Returns the description of the failure.
-
matches() public
Checks assertion
-
toString() public
Assertion message
Method Detail
__construct() ¶ public
__construct(Psr\Http\Message\ResponseInterface $response, string $headerName)Constructor.
Parameters
-
Psr\Http\Message\ResponseInterface$response A response instance.
-
string$headerName Header name
_getBodyAsString() ¶ protected
_getBodyAsString(): stringGet the response body as string
Returns
stringadditionalFailureDescription() ¶ protected
additionalFailureDescription(mixed $other): stringReturn additional failure description where needed.
The function can be overridden to provide additional failure information like a diff
Parameters
-
mixed$other evaluated value or object
Returns
stringevaluate() ¶ public
evaluate(mixed $other, string $description = '', bool $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.
Parameters
-
$other -
string$description optional -
bool$returnResult optional
Throws
ExpectationFailedExceptionInvalidArgumentExceptionfail() ¶ protected
fail(mixed $other, string $description, ?ComparisonFailure $comparisonFailure = null): voidThrows an exception for the given compared value and test description.
Parameters
-
mixed$other evaluated value or object
-
string$description Additional information about the test
-
?ComparisonFailure$comparisonFailure optional
Returns
voidThrows
ExpectationFailedExceptionInvalidArgumentExceptionfailureDescription() ¶ protected
failureDescription(mixed $other): stringReturns 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.
To provide additional failure information additionalFailureDescription can be used.
Parameters
-
mixed$other evaluated value or object
Returns
stringThrows
InvalidArgumentExceptionmatches() ¶ public
matches(mixed $other): boolChecks assertion
This method can be overridden to implement the evaluation algorithm.
Parameters
-
mixed$other Expected content
Returns
bool