Class StatusCode

StatusCode

Namespace: Cake\TestSuite\Constraint\Response

Properties summary

  • $code protected
    int|array
  • $response protected
    \Psr\Http\Message\ResponseInterface

Method Summary

Method Detail

__construct() public 

__construct(?\Psr\Http\Message\ResponseInterface $response)

Constructor

Parameters

\Psr\Http\Message\ResponseInterface|null $response

Response

_getBodyAsString() protected 

_getBodyAsString()

Get the response body as string

Returns

string

The response body.

additionalFailureDescription() protected 

additionalFailureDescription(mixed $other)

Return 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

count() public 

count()

Counts the number of constraint elements.

evaluate() public 

evaluate(mixed $other, string $description, bool $returnResult)

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

mixed $other
string $description optional
bool $returnResult optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

exporter() protected 

exporter()

fail() protected 

fail(mixed $other, mixed $description, \SebastianBergmann\Comparator\ComparisonFailure $comparisonFailure)

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

\SebastianBergmann\Comparator\ComparisonFailure $comparisonFailure optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

failureDescription() public 

failureDescription(mixed $other)

Failure description

Parameters

mixed $other

Expected code

Returns

string

matches() public 

matches(mixed $other)

Check assertion

Parameters

int|array $other

Array of min/max status codes, or a single code

Returns

bool

statusCodeBetween() protected 

statusCodeBetween(int $min, int $max)

Helper for checking status codes

Parameters

int $min

Min status code (inclusive)

int $max

Max status code (inclusive)

Returns

bool

toString() public 

toString()

Assertion message

Returns

string

Property Detail

$code protected

Type

int|array

$response protected

Type

\Psr\Http\Message\ResponseInterface

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.TestSuite.Constraint.Response.StatusCode.html