1. class
  2. mako
  3. \
  4. http
  5. \
  6. Response

Response

class Response

HTTP response.

Constants

DEFAULT_STATUS

Default status code.

Properties

protected Request $request Request instance.
protected mixed $body Response body.
protected string $contentType Response content type.
protected string $charset Response character set.
protected int $statusCode Status code.
protected Headers $headers Response headers.
protected Cookies $cookies Cookies.
protected bool $outputCompression Compress output?
protected bool $responseCache Enable response cache?
protected array $statusCodes HTTP status codes.

Methods

__construct(Request $request, string $charset = 'UTF-8', Signer|null $signer = null)

Constructor.

Response
setBody(mixed $body)

Sets the response body.

mixed
getBody()

Returns the response body.

Response
clearBody()

Clears the response body.

Response
setType(string $contentType, string|null $charset = null)

Sets the response content type.

string
getType()

Returns the response content type.

Response
setCharset(string $charset)

Sets the response character set.

string
getCharset()

Returns the response character set.

Response
setStatus(int $statusCode)

Sets the HTTP status code.

int
getStatus()

Returns the HTTP status code.

Headers
getHeaders()

Returns response header collection.

Cookies
getCookies()

Returns response cookie collection.

Response
clear()

Clears the response body, cookies and headers.

Response
reset()

Resets the response.

sendHeaders()

Sends response headers.

Response
enableCaching()

Enables ETag response cache.

Response
disableCaching()

Disables ETag response cache.

Response
enableCompression()

Enables output compression.

Response
disableCompression()

Disables output compression.

send()

Send output to browser.

Details

at line 203
__construct(Request $request, string $charset = 'UTF-8', Signer|null $signer = null)

Constructor.

Parameters

Request $request Request instance
string $charset Response character set
Signer|null $signer Signer instance used to sign cookies

at line 220
Response setBody(mixed $body)

Sets the response body.

Parameters

mixed $body Response body

Return Value

Response

at line 232
mixed getBody()

Returns the response body.

Return Value

mixed

at line 242
Response clearBody()

Clears the response body.

Return Value

Response

at line 256
Response setType(string $contentType, string|null $charset = null)

Sets the response content type.

Parameters

string $contentType Content type
string|null $charset Charset

Return Value

Response

at line 273
string getType()

Returns the response content type.

Return Value

string

at line 284
Response setCharset(string $charset)

Sets the response character set.

Parameters

string $charset Character set

Return Value

Response

at line 296
string getCharset()

Returns the response character set.

Return Value

string

at line 307
Response setStatus(int $statusCode)

Sets the HTTP status code.

Parameters

int $statusCode HTTP status code

Return Value

Response

at line 322
int getStatus()

Returns the HTTP status code.

Return Value

int

at line 332
Headers getHeaders()

Returns response header collection.

Return Value

Headers

at line 342
Cookies getCookies()

Returns response cookie collection.

Return Value

Cookies

at line 352
Response clear()

Clears the response body, cookies and headers.

Return Value

Response

at line 368
Response reset()

Resets the response.

Return Value

Response

at line 378
sendHeaders()

Sends response headers.

at line 429
Response enableCaching()

Enables ETag response cache.

Return Value

Response

at line 441
Response disableCaching()

Disables ETag response cache.

Return Value

Response

at line 453
Response enableCompression()

Enables output compression.

Return Value

Response

at line 465
Response disableCompression()

Disables output compression.

Return Value

Response

at line 475
send()

Send output to browser.