Symfony2 API
Class

Symfony\Component\HttpFoundation\ResponseHeaderBag

class ResponseHeaderBag extends HeaderBag

ResponseHeaderBag is a container for Response HTTP headers.

Constants

COOKIES_FLAT

COOKIES_ARRAY

DISPOSITION_ATTACHMENT

DISPOSITION_INLINE

Methods

__construct(array $headers = array())

Constructor.
string __toString()

Returns the headers as a string.
array allPreserveCase()

Returns the headers, with original capitalizations.
replace(array $headers = array())

Replaces the current HTTP headers by a new set.
set(string $key, string|array $values, Boolean $replace = true)

Sets a header by name.
remove(string $key)

Removes a header.
hasCacheControlDirective($key)

getCacheControlDirective($key)

setCookie(Cookie $cookie)

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

Removes a cookie from the array, but does not unset it in the browser
array getCookies(string $format = self::COOKIES_FLAT)

Returns an array with all cookies
clearCookie(string $name, string $path = '/', string $domain = null)

Clears a cookie in the browser
string makeDisposition(string $disposition, string $filename, string $filenameFallback = '')

Generates a HTTP Content-Disposition field-value.

Details

at line 51
public __construct(array $headers = array())

Constructor.

Parameters

array $headers An array of HTTP headers

at line 63
public string __toString()

Returns the headers as a string.

Return Value

string The headers

at line 80
public array allPreserveCase()

Returns the headers, with original capitalizations.

Return Value

array An array of headers

at line 90
public replace(array $headers = array())

Replaces the current HTTP headers by a new set.

Parameters

array $headers An array of HTTP headers

at line 106
public set(string $key, string|array $values, Boolean $replace = true)

Sets a header by name.

Parameters

string $key The key
string|array $values The value or an array of values
Boolean $replace Whether to replace the actual value or not (true by default)

at line 127
public remove(string $key)

Removes a header.

Parameters

string $key The HTTP header name

at line 142
public hasCacheControlDirective($key)

Parameters

$key

at line 150
public getCacheControlDirective($key)

Parameters

$key

at line 162
public setCookie(Cookie $cookie)

Sets a cookie.

Parameters

Cookie $cookie

at line 176
public removeCookie(string $name, string $path = '/', string $domain = null)

Removes a cookie from the array, but does not unset it in the browser

Parameters

string $name
string $path
string $domain

at line 204
public array getCookies(string $format = self::COOKIES_FLAT)

Returns an array with all cookies

Parameters

string $format

Return Value

array

Exceptions

InvalidArgumentException When the $format is invalid

at line 235
public clearCookie(string $name, string $path = '/', string $domain = null)

Clears a cookie in the browser

Parameters

string $name
string $path
string $domain

at line 254
public string makeDisposition(string $disposition, string $filename, string $filenameFallback = '')

Generates a HTTP Content-Disposition field-value.

Parameters

string $disposition One of "inline" or "attachment"
string $filename A unicode string
string $filenameFallback A string containing only ASCII characters that is semantically equivalent to $filename. If the filename is already ASCII, it can be omitted, or just copied from $filename

Return Value

string A string suitable for use as a Content-Disposition field-value.

Exceptions

InvalidArgumentException

See also

RFC 6266