Class StatusFailure
StatusFailure
Property Summary
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
-
fail() protected
Throws an exception for the given compared value and test description
-
failureDescription() protected
Overwrites the descriptions so we can remove the automatic "expected" message
-
matches() public
Check assertion
-
statusCodeBetween() protected
Helper for checking status codes
-
toString() public
Assertion message
Method Detail
__construct() ¶ public
__construct(Cake\Http\Response $response)Constructor
Parameters
-
Cake\Http\Response$response Response
_getBodyAsString() ¶ protected
_getBodyAsString(): stringGet the response body as string
Returns
stringThe response body.
additionalFailureDescription() ¶ 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): mixedEvaluates 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
-
mixed$other Value or object to evaluate.
-
string$description optional Additional information about the test
-
bool$returnResult optional Whether to return a result or throw an exception
Returns
mixedThrows
ExpectationFailedExceptionfail() ¶ protected
fail(mixed $other, string $description, ComparisonFailure $comparisonFailure = null)Throws 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
Throws
ExpectationFailedExceptionfailureDescription() ¶ protected
failureDescription(mixed $other): stringOverwrites the descriptions so we can remove the automatic "expected" message
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 Value
Returns
stringmatches() ¶ public
matches(mixed $other): boolCheck assertion
This method can be overridden to implement the evaluation algorithm.
Parameters
-
mixed$other Array of min/max status codes, or a single code
Returns
boolstatusCodeBetween() ¶ protected
statusCodeBetween(int $min, int $max): boolHelper for checking status codes
Parameters
-
int$min Min status code (inclusive)
-
int$max Max status code (inclusive)
Returns
bool