Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. ResponseHasCookie.php

class ResponseHasCookie

Hierarchy

  • class \PHPUnit\Framework\Constraint\Constraint implements \Countable, \PHPUnit\Framework\SelfDescribing
    • class \Symfony\Component\HttpFoundation\Test\Constraint\ResponseHasCookie extends \PHPUnit\Framework\Constraint\Constraint

Expanded class hierarchy of ResponseHasCookie

File

vendor/symfony/http-foundation/Test/Constraint/ResponseHasCookie.php, line 18

Namespace

Symfony\Component\HttpFoundation\Test\Constraint
View source
final class ResponseHasCookie extends Constraint {
    public function __construct(string $name, string $path = '/', ?string $domain = null) {
    }
    public function toString() : string {
        $str = \sprintf('has cookie "%s"', $this->name);
        if ('/' !== $this->path) {
            $str .= \sprintf(' with path "%s"', $this->path);
        }
        if ($this->domain) {
            $str .= \sprintf(' for domain "%s"', $this->domain);
        }
        return $str;
    }
    
    /**
     * @param Response $response
     */
    protected function matches($response) : bool {
        return null !== $this->getCookie($response);
    }
    
    /**
     * @param Response $response
     */
    protected function failureDescription($response) : string {
        return 'the Response ' . $this->toString();
    }
    private function getCookie(Response $response) : ?Cookie {
        $cookies = $response->headers
            ->getCookies();
        $filteredCookies = array_filter($cookies, fn(Cookie $cookie) => $cookie->getName() === $this->name && $cookie->getPath() === $this->path && $cookie->getDomain() === $this->domain);
        return reset($filteredCookies) ?: null;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
Constraint::additionalFailureDescription protected function Return additional failure description where needed. 7
Constraint::count public function Counts the number of constraint elements. 3
Constraint::evaluate public function Evaluates the constraint for parameter $other. 7
Constraint::exporter protected function
Constraint::fail protected function Throws an exception for the given compared value and test description. 1
Constraint::failureDescriptionInContext protected function Returns the description of the failure when this constraint appears in
context of an $operator expression.
Constraint::reduce protected function Reduces the sub-expression starting at $this by skipping degenerate
sub-expression and returns first descendant constraint that starts
a non-reducible sub-expression.
2
Constraint::toStringInContext protected function Returns a custom string representation of the constraint object when it
appears in context of an $operator expression.
Constraint::valueToTypeStringFragment protected function @psalm-return non-empty-string
ResponseHasCookie::failureDescription protected function Overrides Constraint::failureDescription
ResponseHasCookie::getCookie private function
ResponseHasCookie::matches protected function Overrides Constraint::matches
ResponseHasCookie::toString public function Returns a string representation of the object. Overrides SelfDescribing::toString
ResponseHasCookie::__construct public function

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal