Symfony\Component\HttpFoundation\ResponseHeaderBag::getCookies PHP Method

getCookies() public method

Returns an array with all cookies.
public getCookies ( string $format = self::COOKIES_FLAT ) : array
$format string
return array
    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;
    }

Usage Example

 public function testRemoveCookie()
 {
     $bag = new ResponseHeaderBag();
     $bag->setCookie(new Cookie('foo', 'bar', 0, '/path/foo', 'foo.bar'));
     $bag->setCookie(new Cookie('bar', 'foo', 0, '/path/bar', 'foo.bar'));
     $cookies = $bag->getCookies(ResponseHeaderBag::COOKIES_ARRAY);
     $this->assertTrue(isset($cookies['foo.bar']['/path/foo']));
     $bag->removeCookie('foo', '/path/foo', 'foo.bar');
     $cookies = $bag->getCookies(ResponseHeaderBag::COOKIES_ARRAY);
     $this->assertFalse(isset($cookies['foo.bar']['/path/foo']));
     $bag->removeCookie('bar', '/path/bar', 'foo.bar');
     $cookies = $bag->getCookies(ResponseHeaderBag::COOKIES_ARRAY);
     $this->assertFalse(isset($cookies['foo.bar']));
 }
All Usage Examples Of Symfony\Component\HttpFoundation\ResponseHeaderBag::getCookies