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

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

Sets HTTP response code.

int
getCode()

Returns HTTP response code.

setHeader(string $name, string $value)

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

addHeader(string $name, string $value)

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

deleteHeader(string $name)

Deletes a previously sent HTTP header.

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

Sends a Content-type HTTP header.

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.

setExpiration(string|null $expires)

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.

__destruct()

No description

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

Sends a cookie.

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

Deletes a cookie.

Details

at line 44
__construct()

No description

at line 57
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 75
int getCode()

Returns HTTP response code.

Return Value

int

at line 85
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 104
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 116
IResponse deleteHeader(string $name)

Deletes a previously sent HTTP header.

Parameters

string $name

Return Value

IResponse

Exceptions

InvalidStateException

at line 128
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 139
Response sendAsFile(string $fileName)

Response should be downloaded with 'Save as' dialog.

Parameters

string $fileName

Return Value

Response

Exceptions

InvalidStateException

at line 154
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 170
IResponse setExpiration(string|null $expires)

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 $expires

Return Value

IResponse

Exceptions

InvalidStateException

at line 190
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 199
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 216
array getHeaders()

Returns all sent HTTP headers as associative array.

Return Value

array

at line 228
__destruct()

No description

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

Sends a cookie.

Parameters

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

Return Value

IResponse

Exceptions

InvalidStateException

at line 273
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