Symfony2 API
Class

Symfony\Component\BrowserKit\CookieJar

class CookieJar

CookieJar.

Methods

set(Cookie $cookie)

Sets a cookie.
Cookie|null get(string $name, string $path = '/', string $domain = null)

Gets a cookie by name.
expire(string $name, string $path = '/', string $domain = null)

Removes a cookie by name.
clear()

Removes all the cookies from the jar.
updateFromSetCookie(array $setCookies, string $uri = null)

Updates the cookie jar from a response Set-Cookie headers.
updateFromResponse(Response $response, string $uri = null)

Updates the cookie jar from a Response object.
Cookie[] all()

Returns not yet expired cookies.
array allValues(string $uri, Boolean $returnsRawValue = false)

Returns not yet expired cookie values for the given URI.
array allRawValues(string $uri)

Returns not yet expired raw cookie values for the given URI.
flushExpiredCookies()

Removes all expired cookies.

Details

at line 32
public set(Cookie $cookie)

Sets a cookie.

Parameters

Cookie $cookie A Cookie instance

at line 53
public Cookie|null get(string $name, string $path = '/', string $domain = null)

Gets a cookie by name.

You should never use an empty domain, but if you do so,
this method returns the first cookie for the given name/path
(this behavior ensures a BC behavior with previous versions of
Symfony).

Parameters

string $name The cookie name
string $path The cookie path
string $domain The cookie domain

Return Value

Cookie|null A Cookie instance or null if the cookie does not exist

at line 84
public expire(string $name, string $path = '/', string $domain = null)

Removes a cookie by name.

You should never use an empty domain, but if you do so,
all cookies for the given name/path expire (this behavior
ensures a BC behavior with previous versions of Symfony).

Parameters

string $name The cookie name
string $path The cookie path
string $domain The cookie domain

at line 116
public clear()

Removes all the cookies from the jar.

at line 127
public updateFromSetCookie(array $setCookies, string $uri = null)

Updates the cookie jar from a response Set-Cookie headers.

Parameters

array $setCookies Set-Cookie headers from an HTTP response
string $uri The base URL

at line 156
public updateFromResponse(Response $response, string $uri = null)

Updates the cookie jar from a Response object.

Parameters

Response $response A Response object
string $uri The base URL

at line 166
public Cookie[] all()

Returns not yet expired cookies.

Return Value

Cookie[] An array of cookies

at line 190
public array allValues(string $uri, Boolean $returnsRawValue = false)

Returns not yet expired cookie values for the given URI.

Parameters

string $uri A URI
Boolean $returnsRawValue Returns raw value or urldecoded value

Return Value

array An array of cookie values

at line 229
public array allRawValues(string $uri)

Returns not yet expired raw cookie values for the given URI.

Parameters

string $uri A URI

Return Value

array An array of cookie values

at line 237
public flushExpiredCookies()

Removes all expired cookies.