Class CodeIgniter\HTTP\DownloadResponse

`extends`	`Response`

HTTP response when a download is requested.

CodeIgniter\HTTP\Message implements MessageInterface uses MessageTrait
- CodeIgniter\HTTP\Response implements ResponseInterface uses ResponseTrait
  - CodeIgniter\HTTP\DownloadResponse

Methods


					
	public

__construct(string $filename, bool $setMime)

Constructor.

Overrides

CodeIgniter\HTTP\Response::__construct()


					
	public

setBinary(string $binary)

set download for binary string.


					
	public

setFilePath(string $filepath)

set download for file.


					
	public

setFileName(string $filename): $this

set name for the download.


					
	public

getContentLength(): int

get content length.


					
	public

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

Disallows status changing.

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\Exceptions\DownloadException

Implements

CodeIgniter\HTTP\ResponseInterface::setStatusCode()


					
	public

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

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

Implements

CodeIgniter\HTTP\ResponseInterface::setContentType()


					
	public

noCache(): self

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

Implements

CodeIgniter\HTTP\ResponseInterface::noCache()


					
	public

setCache(array $options = [])

Disables cache configuration.

Throws

CodeIgniter\Exceptions\DownloadException

Implements

CodeIgniter\HTTP\ResponseInterface::setCache()


					
	public

send(): $this

{@inheritDoc}

Implements

CodeIgniter\HTTP\ResponseInterface::send()


					
	public

buildHeaders()

set header for file download.


					
	public

sendBody(): DownloadResponse

output download file text.

Throws

CodeIgniter\Exceptions\DownloadException

Implements

CodeIgniter\HTTP\ResponseInterface::sendBody()

Methods inherited from CodeIgniter\HTTP\Response
`pretend(), getStatusCode(), getReason(), getReasonPhrase()`

Methods inherited from CodeIgniter\HTTP\Message
`getBody(), getHeaders(), getHeader(), hasHeader(), getHeaderLine(), getProtocolVersion()`

Methods used from CodeIgniter\HTTP\MessageTrait
`setBody(), appendBody(), populateHeaders(), headers(), header(), setHeader(), removeHeader(), appendHeader(), prependHeader(), getHeaderName(), setProtocolVersion()`

Methods used from CodeIgniter\HTTP\ResponseTrait
`setDate(), setLink(), setJSON(), getJSON(), setXML(), getXML(), formatBody(), setLastModified(), sendHeaders(), redirect(), setCookie(), getCookieStore(), hasCookie(), getCookie(), deleteCookie(), getCookies(), sendCookies(), download(), getCSP()`

Constants inherited from CodeIgniter\HTTP\ResponseInterface
HTTP_CONTINUE, HTTP_SWITCHING_PROTOCOLS, HTTP_PROCESSING, HTTP_EARLY_HINTS, HTTP_OK, HTTP_CREATED, HTTP_ACCEPTED, HTTP_NONAUTHORITATIVE_INFORMATION, HTTP_NO_CONTENT, HTTP_RESET_CONTENT, HTTP_PARTIAL_CONTENT, HTTP_MULTI_STATUS, HTTP_ALREADY_REPORTED, HTTP_IM_USED, HTTP_MULTIPLE_CHOICES, HTTP_MOVED_PERMANENTLY, HTTP_FOUND, HTTP_SEE_OTHER, HTTP_NOT_MODIFIED, HTTP_USE_PROXY, HTTP_SWITCH_PROXY, HTTP_TEMPORARY_REDIRECT, HTTP_PERMANENT_REDIRECT, HTTP_BAD_REQUEST, HTTP_UNAUTHORIZED, HTTP_PAYMENT_REQUIRED, HTTP_FORBIDDEN, HTTP_NOT_FOUND, HTTP_METHOD_NOT_ALLOWED, HTTP_NOT_ACCEPTABLE, HTTP_PROXY_AUTHENTICATION_REQUIRED, HTTP_REQUEST_TIMEOUT, HTTP_CONFLICT, HTTP_GONE, HTTP_LENGTH_REQUIRED, HTTP_PRECONDITION_FAILED, HTTP_PAYLOAD_TOO_LARGE, HTTP_URI_TOO_LONG, HTTP_UNSUPPORTED_MEDIA_TYPE, HTTP_RANGE_NOT_SATISFIABLE, HTTP_EXPECTATION_FAILED, HTTP_IM_A_TEAPOT, HTTP_MISDIRECTED_REQUEST, HTTP_UNPROCESSABLE_ENTITY, HTTP_LOCKED, HTTP_FAILED_DEPENDENCY, HTTP_TOO_EARLY, HTTP_UPGRADE_REQUIRED, HTTP_PRECONDITION_REQUIRED, HTTP_TOO_MANY_REQUESTS, HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE, HTTP_UNAVAILABLE_FOR_LEGAL_REASONS, HTTP_CLIENT_CLOSED_REQUEST, HTTP_INTERNAL_SERVER_ERROR, HTTP_NOT_IMPLEMENTED, HTTP_BAD_GATEWAY, HTTP_SERVICE_UNAVAILABLE, HTTP_GATEWAY_TIMEOUT, HTTP_HTTP_VERSION_NOT_SUPPORTED, HTTP_VARIANT_ALSO_NEGOTIATES, HTTP_INSUFFICIENT_STORAGE, HTTP_LOOP_DETECTED, HTTP_NOT_EXTENDED, HTTP_NETWORK_AUTHENTICATION_REQUIRED, HTTP_NETWORK_CONNECT_TIMEOUT_ERROR

Constants inherited from CodeIgniter\HTTP\ResponseInterface

HTTP_CONTINUE, HTTP_SWITCHING_PROTOCOLS, HTTP_PROCESSING, HTTP_EARLY_HINTS, HTTP_OK, HTTP_CREATED, HTTP_ACCEPTED, HTTP_NONAUTHORITATIVE_INFORMATION, HTTP_NO_CONTENT, HTTP_RESET_CONTENT, HTTP_PARTIAL_CONTENT, HTTP_MULTI_STATUS, HTTP_ALREADY_REPORTED, HTTP_IM_USED, HTTP_MULTIPLE_CHOICES, HTTP_MOVED_PERMANENTLY, HTTP_FOUND, HTTP_SEE_OTHER, HTTP_NOT_MODIFIED, HTTP_USE_PROXY, HTTP_SWITCH_PROXY, HTTP_TEMPORARY_REDIRECT, HTTP_PERMANENT_REDIRECT, HTTP_BAD_REQUEST, HTTP_UNAUTHORIZED, HTTP_PAYMENT_REQUIRED, HTTP_FORBIDDEN, HTTP_NOT_FOUND, HTTP_METHOD_NOT_ALLOWED, HTTP_NOT_ACCEPTABLE, HTTP_PROXY_AUTHENTICATION_REQUIRED, HTTP_REQUEST_TIMEOUT, HTTP_CONFLICT, HTTP_GONE, HTTP_LENGTH_REQUIRED, HTTP_PRECONDITION_FAILED, HTTP_PAYLOAD_TOO_LARGE, HTTP_URI_TOO_LONG, HTTP_UNSUPPORTED_MEDIA_TYPE, HTTP_RANGE_NOT_SATISFIABLE, HTTP_EXPECTATION_FAILED, HTTP_IM_A_TEAPOT, HTTP_MISDIRECTED_REQUEST, HTTP_UNPROCESSABLE_ENTITY, HTTP_LOCKED, HTTP_FAILED_DEPENDENCY, HTTP_TOO_EARLY, HTTP_UPGRADE_REQUIRED, HTTP_PRECONDITION_REQUIRED, HTTP_TOO_MANY_REQUESTS, HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE, HTTP_UNAVAILABLE_FOR_LEGAL_REASONS, HTTP_CLIENT_CLOSED_REQUEST, HTTP_INTERNAL_SERVER_ERROR, HTTP_NOT_IMPLEMENTED, HTTP_BAD_GATEWAY, HTTP_SERVICE_UNAVAILABLE, HTTP_GATEWAY_TIMEOUT, HTTP_HTTP_VERSION_NOT_SUPPORTED, HTTP_VARIANT_ALSO_NEGOTIATES, HTTP_INSUFFICIENT_STORAGE, HTTP_LOOP_DETECTED, HTTP_NOT_EXTENDED, HTTP_NETWORK_AUTHENTICATION_REQUIRED, HTTP_NETWORK_CONNECT_TIMEOUT_ERROR

Properties
`protected`	`string`	`$reason = 'OK'`	#
`protected`	`int`	`$statusCode = 200`	#

Properties inherited from CodeIgniter\HTTP\Response
`$statusCodes,`

Properties inherited from CodeIgniter\HTTP\Message
`$protocolVersion, $validProtocolVersions, $body`

Properties used from CodeIgniter\HTTP\MessageTrait
`$headers, $headerMap`

Properties used from CodeIgniter\HTTP\ResponseTrait
`$CSPEnabled, $CSP, $cookieStore, $cookiePrefix, $cookieDomain, $cookiePath, $cookieSecure, $cookieHTTPOnly, $cookieSameSite, $cookies, $bodyFormat,`

Namespaces

Classes

Interfaces

Traits

Class CodeIgniter\HTTP\DownloadResponse

Overrides

Parameters

Throws

Implements

Implements

Implements

Throws

Implements

Implements

Throws

Implements