function ResponseHeaderBag::getCookies

Returns an array with all cookies.

Return value

Cookie[]

Throws

\InvalidArgumentException When the $format is invalid

1 call to ResponseHeaderBag::getCookies()

ResponseHeaderBag::all in vendor/symfony/http-foundation/ResponseHeaderBag.php

Returns the headers.

File

vendor/symfony/http-foundation/ResponseHeaderBag.php, line 195

Class

ResponseHeaderBag

ResponseHeaderBag is a container for Response HTTP headers.

Namespace

Symfony\Component\HttpFoundation

Code

public function getCookies(string $format = self::COOKIES_FLAT) : array {
    if (!\in_array($format, [
        self::COOKIES_FLAT,
        self::COOKIES_ARRAY,
    ])) {
        throw new \InvalidArgumentException(\sprintf('Format "%s" invalid (%s).', $format, implode(', ', [
            self::COOKIES_FLAT,
            self::COOKIES_ARRAY,
        ])));
    }
    if (self::COOKIES_ARRAY === $format) {
        return $this->cookies;
    }
    $flattenedCookies = [];
    foreach ($this->cookies as $path) {
        foreach ($path as $cookies) {
            foreach ($cookies as $cookie) {
                $flattenedCookies[] = $cookie;
            }
        }
    }
    return $flattenedCookies;
}