Class StatusSuccess
StatusSuccess
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.
-
exporter() protected
-
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
-
failureDescriptionInContext() protected
Returns the description of the failure when this constraint appears in context of an $operator expression.
-
matches() public
Check assertion
-
reduce() protected
Reduces the sub-expression starting at $this by skipping degenerate sub-expression and returns first descendant constraint that starts a non-reducible sub-expression.
-
statusCodeBetween() protected
Helper for checking status codes
-
toString() public
Assertion message
-
toStringInContext() protected
Returns a custom string representation of the constraint object when it appears in context of an $operator expression.
Method Detail
__construct() ¶ public
__construct(Psr\Http\Message\ResponseInterface|null $response)Constructor
Parameters
-
Psr\Http\Message\ResponseInterface|null$response Response
_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): ?boolEvaluates 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
Returns
?boolThrows
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): 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
stringfailureDescriptionInContext() ¶ protected
failureDescriptionInContext(Operator $operator, mixed $role, mixed $other): stringReturns the description of the failure when this constraint appears in context of an $operator expression.
The purpose of this method is to provide meaningful failure description in context of operators such as LogicalNot. Native PHPUnit constraints are supported out of the box by LogicalNot, but externally developed ones had no way to provide correct messages in this context.
The method shall return empty string, when it does not handle customization by itself.
Parameters
-
Operator$operator the $operator of the expression
-
mixed$role role of $this constraint in the $operator expression
-
mixed$other evaluated value or object
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
boolreduce() ¶ protected
reduce(): selfReduces the sub-expression starting at $this by skipping degenerate sub-expression and returns first descendant constraint that starts a non-reducible sub-expression.
Returns $this for terminal constraints and for operators that start non-reducible sub-expression, or the nearest descendant of $this that starts a non-reducible sub-expression.
A constraint expression may be modelled as a tree with non-terminal nodes (operators) and terminal nodes. For example:
LogicalOr (operator, non-terminal)
- LogicalAnd (operator, non-terminal) | + IsType('int') (terminal) | + GreaterThan(10) (terminal)
- LogicalNot (operator, non-terminal)
- IsType('array') (terminal)
A degenerate sub-expression is a part of the tree, that effectively does not contribute to the evaluation of the expression it appears in. An example of degenerate sub-expression is a BinaryOperator constructed with single operand or nested BinaryOperators, each with single operand. An expression involving a degenerate sub-expression is equivalent to a reduced expression with the degenerate sub-expression removed, for example
LogicalAnd (operator)
- LogicalOr (degenerate operator) | + LogicalAnd (degenerate operator) | + IsType('int') (terminal)
- GreaterThan(10) (terminal)
is equivalent to
LogicalAnd (operator)
- IsType('int') (terminal)
- GreaterThan(10) (terminal)
because the subexpression
- LogicalOr
- LogicalAnd
- -
- LogicalAnd
is degenerate. Calling reduce() on the LogicalOr object above, as well as on LogicalAnd, shall return the IsType('int') instance.
Other specific reductions can be implemented, for example cascade of LogicalNot operators
- LogicalNot
- LogicalNot
+LogicalNot
- IsTrue
- LogicalNot
+LogicalNot
can be reduced to
LogicalNot
- IsTrue
Returns
selfstatusCodeBetween() ¶ 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
booltoStringInContext() ¶ protected
toStringInContext(Operator $operator, mixed $role): stringReturns a custom string representation of the constraint object when it appears in context of an $operator expression.
The purpose of this method is to provide meaningful descriptive string in context of operators such as LogicalNot. Native PHPUnit constraints are supported out of the box by LogicalNot, but externally developed ones had no way to provide correct strings in this context.
The method shall return empty string, when it does not handle customization by itself.
Parameters
-
Operator$operator the $operator of the expression
-
mixed$role role of $this constraint in the $operator expression
Returns
string