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.2 Strawberry API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 4.2
      • 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 HeaderNotSet

HeaderSet

Namespace: Cake\TestSuite\Constraint\Response

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

    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

    Checks 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.

  • 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, string $headerName)

Constructor.

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

A response instance.

string $headerName

Header name

_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): ?bool

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
Returns
?bool
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

failureDescriptionInContext() ¶ protected

failureDescriptionInContext(Operator $operator, mixed $role, mixed $other): string

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

matches() ¶ public

matches(mixed $other): bool

Checks assertion

This method can be overridden to implement the evaluation algorithm.

Parameters
mixed $other

Expected content

Returns
bool

reduce() ¶ protected

reduce(): self

Reduces 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
      • -

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

can be reduced to

LogicalNot

  • IsTrue
Returns
self

toString() ¶ public

toString(): string

Assertion message

Returns
string

toStringInContext() ¶ protected

toStringInContext(Operator $operator, mixed $role): string

Returns 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

Property Detail

$headerName ¶ protected

Type
string

$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