public function ResponseHeaderBag::getCookies

Returns an array with all cookies

@api

Parameters

string $format:

Return value

array

Throws

\InvalidArgumentException When the $format is invalid

File

drupal/core/vendor/symfony/http-foundation/Symfony/Component/HttpFoundation/ResponseHeaderBag.php, line 178

Class

ResponseHeaderBag

ResponseHeaderBag is a container for Response HTTP headers.

Namespace

Code

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