CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 4.1 Strawberry API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 4.1
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Command
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
      • Constraint
        • Console
        • Email
        • Response
        • Session
        • View
      • Fixture
      • Stub
    • Utility
    • Validation
    • View

Class StatusCodeBase

StatusCodeBase

Abstract
Namespace: Cake\TestSuite\Constraint\Response

Property Summary

  • $code protected
    int|array
  • $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

    Overwrites the descriptions so we can remove the automatic "expected" message

  • matches() public

    Check assertion

  • statusCodeBetween() protected

    Helper for checking status codes

  • toString() public

    Returns a string representation of the object.

Method Detail

__construct() ¶ public

__construct(Psr\Http\Message\ResponseInterface|null $response)

Constructor

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

Response

_getBodyAsString() ¶ protected

_getBodyAsString(): string

Get the response body as string

Returns
string

additionalFailureDescription() ¶ protected

additionalFailureDescription(mixed $other): string

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

Returns
string

count() ¶ public

count(): int

Counts the number of constraint elements.

Returns
int

evaluate() ¶ 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
ExpectationFailedException

InvalidArgumentException

exporter() ¶ protected

exporter(): Exporter
Returns
Exporter

fail() ¶ protected

fail(mixed $other, string $description, ?ComparisonFailure $comparisonFailure = null): void

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
Returns
void
Throws
ExpectationFailedException

InvalidArgumentException

failureDescription() ¶ protected

failureDescription(mixed $other): string

Overwrites 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
string

matches() ¶ public

matches(mixed $other): bool

Check 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
bool

statusCodeBetween() ¶ protected

statusCodeBetween(int $min, int $max): bool

Helper for checking status codes

Parameters
int $min

Min status code (inclusive)

int $max

Max status code (inclusive)

Returns
bool

toString() ¶ public

toString(): string

Returns a string representation of the object.

Returns
string

Property Detail

$code ¶ protected

Type
int|array

$response ¶ protected

Type
Psr\Http\Message\ResponseInterface
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs