Trait CodeIgniter\HTTP\ResponseTrait


					
	public

setStatusCode(int $code, string $reason = ''): $this

Return an instance with the specified status code and, optionally, reason phrase.

If no reason phrase is specified, will default recommended reason phrase for the response's status code.

Parameters

`$code`	The 3-digit integer result code to set.
`$reason`	The reason phrase to use with the provided status code; if none is provided, will default to the IANA name.

Throws

CodeIgniter\HTTP\Exceptions\HTTPException

For invalid status code arguments.

#


					
	public

setDate(DateTime $date): $this

Sets the date header

#


					
	public

setLink(PagerInterface $pager): $this

Set the Link Header

#


					
	public

setContentType(string $mime, string $charset = 'UTF-8'): $this

Sets the Content Type header for this response with the mime type and, optionally, the charset.

#


					
	public

setJSON(array|string $body, bool $unencoded = false): $this

Converts the $body into JSON and sets the Content Type header.

#


					
	public

getJSON(): string|null

Returns the current body, converted to JSON is it isn't already.

Throws

InvalidArgumentException

If the body property is not array.

#


					
	public

setXML(array|string $body): $this

Converts $body into XML, and sets the correct Content-Type.

#


					
	public

getXML(): bool|string|null

Retrieves the current body into XML and returns it.

Throws

InvalidArgumentException

If the body property is not array.

#


					
	protected

formatBody(array|string $body, string $format): mixed

Handles conversion of the data into the appropriate format, and sets the correct Content-Type header for our response.

Parameters

$format

Valid: json, xml

Throws

InvalidArgumentException

If the body property is not string or array.

#


					
	public

noCache(): $this

Sets the appropriate headers to ensure this response is not cached by the browsers.

#


					
	public

setCache(array $options = []): $this

A shortcut method that allows the developer to set all of the cache-control headers in one method call.

The options array is used to provide the cache-control directives for the header. It might look something like:

$options = [ 'max-age' => 300, 's-maxage' => 900 'etag' => 'abcde', ];

Typical options are:

etag
last-modified
max-age
s-maxage
private
public
must-revalidate
proxy-revalidate
no-transform

#


					
	public

setLastModified(DateTime|string $date): $this

Sets the Last-Modified date header.

$date can be either a string representation of the date or, preferably, an instance of DateTime.

#


					
	public

send(): $this

Sends the output to the browser.

#


					
	public

sendHeaders(): $this

Sends the headers of this HTTP response to the browser.

#


					
	public

sendBody(): $this

Sends the Body of the message to the browser.

#


					
	public

redirect(string $uri, string $method = 'auto', int $code = null): $this

Perform a redirect to a new URL, in two flavors: header or location.

Parameters

`$uri`	The URI to redirect to
`$code`	The type of redirection, defaults to 302

Throws

CodeIgniter\HTTP\Exceptions\HTTPException

For invalid status code.

#


					
	public

setCookie(
	array|Cookie|string $name,
	string $value = '',
	string $expire = '',
	string $domain = '',
	string $path = '/',
	string $prefix = '',
	bool|null $secure = null,
	bool|null $httponly = null,
	string|null $samesite = null,
): $this

Set a cookie

Accepts an arbitrary number of binds (up to 7) or an associative array in the first parameter containing all the values.

Parameters

`$name`	Cookie name / array containing binds / Cookie object
`$value`	Cookie value
`$expire`	Cookie expiration time in seconds
`$domain`	Cookie domain (e.g.: '.yourdomain.com')
`$path`	Cookie path (default: '/')
`$prefix`	Cookie name prefix ('': the default prefix)
`$secure`	Whether to only transfer cookies via SSL
`$httponly`	Whether only make the cookie accessible via HTTP (no javascript)

#


					
	public

getCookieStore(): CookieStore

Returns the `CookieStore` instance.

Returns the CookieStore instance.

#


					
	public

hasCookie(string $name, ?string $value = null, string $prefix = ''): bool

Checks to see if the Response has a specified cookie or not.

#


					
	public

getCookie(?string $name = null, string $prefix = ''): Cookie|Cookie[]|null

Returns the cookie

Parameters

$prefix

Cookie prefix. '': the default prefix

#


					
	public

deleteCookie(string $name = '', string $domain = '', string $path = '/', string $prefix = ''): $this

Sets a cookie to be deleted when the response is sent.

#


					
	public

getCookies(): Cookie[]

Returns all cookies currently set.

#


					
	protected

sendCookies()

Actually sets the cookies.

#


					
	public

download(string $filename = '', string|null $data = '', bool $setMime = false): DownloadResponse|null

Force a download.

Generates the headers that force a download to happen. And sends the file to the browser.

Parameters

`$filename`	The name you want the downloaded file to be named or the path to the file to send
`$data`	The data to be downloaded. Set null if the $filename is the file path
`$setMime`	Whether to try and send the actual MIME type

#


					
	public

getCSP(): ContentSecurityPolicy

#

Properties
`protected`	`bool`	`$CSPEnabled = false`	#
`public`	`ContentSecurityPolicy`	`$CSP`	#
`protected`	`CookieStore`	`$cookieStore`	#
`protected`	`string`	`$cookiePrefix = ''`	#
`protected`	`string`	`$cookieDomain = ''`	#
`protected`	`string`	`$cookiePath = '/'`	#
`protected`	`bool`	`$cookieSecure = false`	#
`protected`	`bool`	`$cookieHTTPOnly = false`	#
`protected`	`string`	`$cookieSameSite = Cookie::SAMESITE_LAX`	#
`protected`	`array`	`$cookies = []`	#
`protected`	`string`	`$bodyFormat = 'html'`	#
`public`	`array`	`$statusCodes`	#

Namespaces

Classes

Interfaces

Traits

Trait CodeIgniter\HTTP\ResponseTrait

Parameters

Throws

Throws

Throws

Parameters

Throws

Parameters

Throws

Parameters

Parameters

Parameters