\Omega\Http Response

Response class.

The Response class provides methods to build and send HTTP responses in an Omega application.

Summary

Methods

Properties

Constants

content
status
header
redirect
json
type
send

No public properties found

REDIRECT
HTML
JSON

No protected methods found

No protected properties found

No protected constants found

No private methods found

type
redirect
content
status
headers

No private constants found

File: Http/Response.php
Class hierarchy: \Omega\Http\Response

Tags

category	Omega
see
author	Adriano Giovannini agisoftt@gmail.com
copyright	Copyright (c) 2024 Adriano Giovannini. (https://omegamvc.github.io)
license	https://www.gnu.org/licenses/gpl-3.0-standalone.html GPL V3.0+
version	1.0.0
package	phpDocumentor
uses
method
property
property-read
property-write

Constant

REDIRECT

REDIRECT = 'REDIRECT' : string

Redirect log level.

This constant represents the log level for redirecting. It can be used to indicate a log entry that involves a redirection process.

File: Http/Response.php

Tags

attributes

HTML

HTML = 'HTML' : string

HTML log level.

This constant represents the log level for HTML messages. It can be utilized for logging events or messages that are specifically related to HTML content or responses.

File: Http/Response.php

Tags

attributes

JSON

JSON = 'JSON' : string

JSON log level.

This constant represents the log level for JSON messages. It can be employed to log events or messages that are associated with JSON data or responses.

File: Http/Response.php

Tags

attributes

Properties

$type

$type : string

Response type.

Type

string — Holds the response type (default is HTML).

$redirect

$redirect : string|null

Response redirect.

Type

string|null — Holds the response redirect URL or null.

$content

$content : string|\Omega\View\View

Response content.

Type

string|View — Holds the response content.

$status

$status : int

Status code.

Type

int — Holds the HTTP status code (default is 200 OK).

$headers

$headers : array

Headers array.

Type

array<string, string> — Holds an array of custom HTTP headers for the response.

Methods

content()

content(string|\Omega\View\View|null  $content = null) : string|self|\Omega\View\View|null

Get or set the response content.

Parameters

string|\Omega\View\View|null

$content

Holds the response content (optional).

Returns

string|self|\Omega\View\View|null —

Returns the content if no argument is provided, otherwise returns $this.

status()

status(int|null  $status = null) : int|$this

Get or set the HTTP status code for the response.

Parameters

int|null

$status

Holds the HTTP status code (optional).

Returns

int|$this —

Returns the status code if no argument is provided, otherwise returns $this.

header()

header(string  $key, string  $value) : $this

Add a custom HTTP header to the response.

Parameters

string	$key	Holds the header key.
string	$value	Holds the header value.

Returns

$this —

Returns $this for method chaining.

redirect()

redirect(string|null  $redirect = null) : string|static|null

Set the response to a redirect with the given URL.

Parameters

string|null

$redirect

Holds the URL to redirect to (optional).

Returns

string|static|null —

Returns the redirect URL if no argument is provided, otherwise returns $this.

json()

json(string|\Omega\View\View  $content) : $this

Set the response content type to JSON and provide JSON data.

Parameters

string|\Omega\View\View

$content

Holds the JSON content to send.

Returns

$this —

Returns $this for method chaining.

type()

type(string|null  $type = null) : string|$this

Get or set the response type (HTML, JSON, or REDIRECT).

Parameters

string|null

$type

Holds the response type (optional).

Returns

string|$this —

Returns the response type if no argument is provided, otherwise returns $this.

send()

send() : void

Send the HTTP response to the client.

This method sends the response headers, status code, and content to the client.

Returns

void —