1. class
  2. Nette
  3. \
  4. Http
  5. \
  6. Response

Response

final class Response implements IResponse

HttpResponse class.

Properties

$cookieDomain

The domain in which the cookie will be available
$cookiePath

The path in which the cookie will be available
$cookieSecure

Whether the cookie is available only through HTTPS
$warnOnBuffer

Whether warn on possible problem with data in output buffer
array read-only $headers

Methods

__construct()

No description

IResponse
setCode(int $code, string|null $reason = null)

Sets HTTP response code.

int
getCode()

Returns HTTP response code.

IResponse
setHeader(string $name, string $value)

Sends an HTTP header and overwrites previously sent header of the same name.

IResponse
addHeader(string $name, string $value)

Sends an HTTP header and doesn't overwrite previously sent header of the same name.

self
deleteHeader(string $name)

Deletes a previously sent HTTP header.

IResponse
setContentType(string $type, string|null $charset = null)

Sends a Content-type HTTP header.

Response
sendAsFile(string $fileName)

Response should be downloaded with 'Save as' dialog.

void
redirect(string $url, int $code = self::S302_Found)

Redirects to another URL. Don't forget to quit the script then.

IResponse
setExpiration(string|null $expire)

Sets the expiration of the HTTP document using the Cache-Control and Expires headers.

bool
isSent()

Returns whether headers have already been sent from the server to the browser, so it is no longer possible to send headers or change the response code.

string|null
getHeader(string $header)

Returns the sent HTTP header, or null if it does not exist. The parameter is case-insensitive.

array
getHeaders()

Returns all sent HTTP headers as associative array.

IResponse
setCookie(string $name, string $value, int|null $expire, string|null $path = null, string|null $domain = null, bool $secure = null, bool $httpOnly = true, string $sameSite = self::SameSiteLax)

Sends a cookie.

deleteCookie(string $name, string|null $path = null, string|null $domain = null, bool $secure = null)

Deletes a cookie.

Details

at line 41
__construct()

No description

at line 54
IResponse setCode(int $code, string|null $reason = null)

Sets HTTP response code.

Parameters

int $code
string|null $reason

Return Value

IResponse

Exceptions

InvalidArgumentException
InvalidStateException

at line 72
int getCode()

Returns HTTP response code.

Return Value

int

at line 82
IResponse setHeader(string $name, string $value)

Sends an HTTP header and overwrites previously sent header of the same name.

Parameters

string $name
string $value

Return Value

IResponse

Exceptions

InvalidStateException

at line 101
IResponse addHeader(string $name, string $value)

Sends an HTTP header and doesn't overwrite previously sent header of the same name.

Parameters

string $name
string $value

Return Value

IResponse

Exceptions

InvalidStateException

at line 113
self deleteHeader(string $name)

Deletes a previously sent HTTP header.

Parameters

string $name

Return Value

self

Exceptions

InvalidStateException

at line 125
IResponse setContentType(string $type, string|null $charset = null)

Sends a Content-type HTTP header.

Parameters

string $type
string|null $charset

Return Value

IResponse

Exceptions

InvalidStateException

at line 136
Response sendAsFile(string $fileName)

Response should be downloaded with 'Save as' dialog.

Parameters

string $fileName

Return Value

Response

Exceptions

InvalidStateException

at line 151
void redirect(string $url, int $code = self::S302_Found)

Redirects to another URL. Don't forget to quit the script then.

Parameters

string $url
int $code

Return Value

void

Exceptions

InvalidStateException

at line 167
IResponse setExpiration(string|null $expire)

Sets the expiration of the HTTP document using the Cache-Control and Expires headers.

The parameter is either a time interval (as text) or null, which disables caching.

Parameters

string|null $expire

Return Value

IResponse

Exceptions

InvalidStateException

at line 187
bool isSent()

Returns whether headers have already been sent from the server to the browser, so it is no longer possible to send headers or change the response code.

Return Value

bool

at line 196
string|null getHeader(string $header)

Returns the sent HTTP header, or null if it does not exist. The parameter is case-insensitive.

Parameters

string $header

Return Value

string|null

at line 213
array getHeaders()

Returns all sent HTTP headers as associative array.

Return Value

array

at line 229
IResponse setCookie(string $name, string $value, int|null $expire, string|null $path = null, string|null $domain = null, bool $secure = null, bool $httpOnly = true, string $sameSite = self::SameSiteLax)

Sends a cookie.

Parameters

string $name
string $value
int|null $expire
string|null $path
string|null $domain
bool $secure
bool $httpOnly
string $sameSite

Return Value

IResponse

Exceptions

InvalidStateException

at line 257
deleteCookie(string $name, string|null $path = null, string|null $domain = null, bool $secure = null)

Deletes a cookie.

Parameters

string $name
string|null $path
string|null $domain
bool $secure

Exceptions

InvalidStateException

Traits

SmartObject