PHP Class Cake\Network\Response

By default controllers will use this class to render their response. If you are going to use a custom response class it should subclass this object in order to ensure compatibility.
Show file Open project: cakephp/cakephp Class Usage Examples

Protected Properties

Property Type Description
$_body string | callable Buffer string or callable for response message
$_cacheDirectives array Holds all the cache directives that will be converted into headers when sending the request
$_charset string The charset the response body is encoded with
$_contentType string Content type to send. This can be an 'extension' that will be transformed using the $_mimetypes array or a complete mime-type
$_cookies array Holds cookies to be sent to the client
$_file Cake\Filesystem\File File object for file to be read out as response
$_fileRange array File range. Used for requesting ranges of files.
$_headers array Buffer list of headers
$_mimeTypes array Holds type key to mime type mappings for known mime types.
$_protocol string Protocol header to send to the client
$_status integer Status code to send to the client
$_statusCodes array Holds HTTP response statuses

Public Methods

Method Description
__construct ( array $options = [] ) Constructor
__debugInfo ( ) : array Returns an array that can be used to describe the internal state of this object.
__toString ( ) : string String conversion. Fetches the response body as a string.
body ( string | callable | null $content = null ) : string Buffers the response message to be sent if $content is null the current buffer is returned
cache ( string $since, string $time = '+1 day' ) : void Sets the correct headers to instruct the client to cache the response.
charset ( string | null $charset = null ) : string Sets the response charset if $charset is null the current charset is returned
checkNotModified ( Cake\Network\Request $request ) : boolean Checks whether a response has not been modified according to the 'If-None-Match' (Etags) and 'If-Modified-Since' (last modification date) request headers. If the response is detected to be not modified, it is marked as so accordingly so the client can be informed of that.
compress ( ) : boolean Sets the correct output buffering handler to send a compressed response. Responses will be compressed with zlib, if the extension is available.
cookie ( array | null $options = null ) : mixed Getter/Setter for cookie configs
cors ( Cake\Network\Request $request, string | array $allowedDomains = [], string | array $allowedMethods = [], string | array $allowedHeaders = [] ) : Cake\Network\CorsBuilder Setup access for origin and methods on cross origin requests
disableCache ( ) : void Sets the correct headers to instruct the client to not cache the response
download ( string $filename ) : void Sets the correct headers to instruct the browser to download the response as a file.
etag ( string | null $hash = null, boolean $weak = false ) : string | null Sets the response Etag, Etags are a strong indicative that a response can be cached by a HTTP client. A bad way of generating Etags is creating a hash of the response output, instead generate a unique hash of the unique components that identifies a request, such as a modification time, a resource Id, and anything else you consider it makes it unique.
expires ( string | DateTime | null $time = null ) : string | null Sets the Expires header for the response by taking an expiration time If called with no parameters it will return the current Expires value
file ( string $path, array $options = [] ) : void Setup for display or download the given file.
getFile ( ) : Cake\Filesystem\File | null Get the current file if one exists.
getMimeType ( string $alias ) : mixed Returns the mime type definition for an alias
header ( string | array | null $header = null, string | array | null $value = null ) : array Buffers a header string to be sent Returns the complete list of buffered headers
httpCodes ( integer | array | null $code = null ) : mixed Queries & sets valid HTTP response codes & messages.
length ( integer | null $bytes = null ) : integer | null Sets the Content-Length header for the response If called with no arguments returns the last Content-Length set
location ( null | string $url = null ) : string | null Accessor for the location header.
mapType ( string | array $ctype ) : string | array | null Maps a content-type back to an alias
maxAge ( integer | null $seconds = null ) : integer | null Sets the Cache-Control max-age directive.
modified ( string | DateTime | null $time = null ) : string | null Sets the Last-Modified header for the response by taking a modification time If called with no parameters it will return the current Last-Modified value
mustRevalidate ( boolean | null $enable = null ) : boolean Sets the Cache-Control must-revalidate directive.
notModified ( ) : void Sets the response as Not Modified by removing any body contents setting the status code to "304 Not Modified" and removing all conflicting headers
outputCompressed ( ) : boolean Returns whether the resulting output will be compressed by PHP
protocol ( string | null $protocol = null ) : string Sets the protocol to be used when sending the response. Defaults to HTTP/1.1 If called with no arguments, it will return the current configured protocol
send ( ) : void Sends the complete response to the client including headers and message body.
sendHeaders ( ) : void Sends the HTTP headers and cookies.
sharable ( boolean | null $public = null, integer | null $time = null ) : boolean | null Sets whether a response is eligible to be cached by intermediate proxies This method controls the public or private directive in the Cache-Control header
sharedMaxAge ( integer | null $seconds = null ) : integer | null Sets the Cache-Control s-maxage directive.
statusCode ( integer | null $code = null ) : integer Sets the HTTP status code to be sent if $code is null the current code is returned
stop ( integer | string $status ) : void Stop execution of the current script. Wraps exit() making testing easier.
type ( string | null $contentType = null ) : mixed Sets the response content type. It can be either a file extension which will be mapped internally to a mime-type or a string representing a mime-type if $contentType is null the current content type is returned if $contentType is an associative array, content type definitions will be stored/replaced
vary ( string | array | null $cacheVariances = null ) : array | null Sets the Vary header for the response, if an array is passed, values will be imploded into a comma separated string. If no parameters are passed, then an array with the current Vary header value is returned

Protected Methods

Method Description
_clearBuffer ( ) : boolean Clears the contents of the topmost output buffer and discards them
_fileRange ( Cake\Filesystem\File $file, string $httpRange ) : void Apply a file range to a file and set the end offset.
_flushBuffer ( ) : void Flushes the contents of the output buffer
_getUTCDate ( string | integer | DateTime | null $time = null ) : DateTime Returns a DateTime object initialized at the $time param and using UTC as timezone
_isActive ( ) : boolean Returns true if connection is still active
_sendContent ( string | callable $content ) : void Sends a content string to the client.
_sendFile ( Cake\Filesystem\File $file, array $range ) : boolean Reads out a file, and echos the content to the client.
_sendHeader ( string $name, string | null $value = null ) : void Sends a header to the client.
_setCacheControl ( ) : void Helper method to generate a valid Cache-Control header from the options set in other methods
_setContent ( ) : void Sets the response body to an empty text if the status code is 204 or 304
_setContentType ( ) : void Formats the Content-Type header based on the configured contentType and charset the charset will only be set in the header if the response is of type text/*
_setCookies ( ) : void Sets the cookies that have been added via Cake\Network\Response::cookie() before any other output is sent to the client. Will set the cookies in the order they have been set.

Method Details

__construct() public method

Constructor
public __construct ( array $options = [] )
$options array list of parameters to setup the response. Possible values are: - body: the response text that should be sent to the client - statusCodes: additional allowable response codes - status: the HTTP status code to respond with - type: a complete mime-type string or an extension mapped in this class - charset: the charset for the response body

__debugInfo() public method

Returns an array that can be used to describe the internal state of this object.
public __debugInfo ( ) : array
return array

__toString() public method

Does *not* send headers. If body is a callable, a blank string is returned.
public __toString ( ) : string
return string

_clearBuffer() protected method

Clears the contents of the topmost output buffer and discards them
Deprecation: 3.2.4 This function is not needed anymore
protected _clearBuffer ( ) : boolean
return boolean

_fileRange() protected method

If an invalid range is requested a 416 Status code will be used in the response.
protected _fileRange ( Cake\Filesystem\File $file, string $httpRange ) : void
$file Cake\Filesystem\File The file to set a range on.
$httpRange string The range to use.
return void

_flushBuffer() protected method

Flushes the contents of the output buffer
Deprecation: 3.2.4 This function is not needed anymore
protected _flushBuffer ( ) : void
return void

_getUTCDate() protected method

Returns a DateTime object initialized at the $time param and using UTC as timezone
protected _getUTCDate ( string | integer | DateTime | null $time = null ) : DateTime
$time string | integer | DateTime | null Valid time string or \DateTime instance.
return DateTime

_isActive() protected method

Returns true if connection is still active
protected _isActive ( ) : boolean
return boolean

_sendContent() protected method

If the content is a callable, it is invoked. The callable should either return a string or output content directly and have no return value.
protected _sendContent ( string | callable $content ) : void
$content string | callable String to send as response body or callable which returns/outputs content.
return void

_sendFile() protected method

Reads out a file, and echos the content to the client.
protected _sendFile ( Cake\Filesystem\File $file, array $range ) : boolean
$file Cake\Filesystem\File File object
$range array The range to read out of the file.
return boolean True is whole file is echoed successfully or false if client connection is lost in between

_sendHeader() protected method

Sends a header to the client.
protected _sendHeader ( string $name, string | null $value = null ) : void
$name string the header name
$value string | null the header value
return void

_setCacheControl() protected method

Helper method to generate a valid Cache-Control header from the options set in other methods
protected _setCacheControl ( ) : void
return void

_setContent() protected method

Sets the response body to an empty text if the status code is 204 or 304
protected _setContent ( ) : void
return void

_setContentType() protected method

Formats the Content-Type header based on the configured contentType and charset the charset will only be set in the header if the response is of type text/*
protected _setContentType ( ) : void
return void

_setCookies() protected method

Sets the cookies that have been added via Cake\Network\Response::cookie() before any other output is sent to the client. Will set the cookies in the order they have been set.
protected _setCookies ( ) : void
return void

body() public method

Buffers the response message to be sent if $content is null the current buffer is returned
public body ( string | callable | null $content = null ) : string
$content string | callable | null the string or callable message to be sent
return string Current message buffer if $content param is passed as null

cache() public method

Sets the correct headers to instruct the client to cache the response.
public cache ( string $since, string $time = '+1 day' ) : void
$since string a valid time since the response text has not been modified
$time string a valid time for cache expiry
return void

charset() public method

Sets the response charset if $charset is null the current charset is returned
public charset ( string | null $charset = null ) : string
$charset string | null Character set string.
return string Current charset

checkNotModified() public method

In order to mark a response as not modified, you need to set at least the Last-Modified etag response header before calling this method. Otherwise a comparison will not be possible.
public checkNotModified ( Cake\Network\Request $request ) : boolean
$request Cake\Network\Request Request object
return boolean Whether the response was marked as not modified or not.

compress() public method

Sets the correct output buffering handler to send a compressed response. Responses will be compressed with zlib, if the extension is available.
public compress ( ) : boolean
return boolean false if client does not accept compressed responses or no handler is available, true otherwise

cors() public method

This method allow multiple ways to setup the domains, see the examples ### Full URI cors($request, 'http://www.cakephp.org'); ### URI with wildcard cors($request, 'http://*.cakephp.org'); ### Ignoring the requested protocol cors($request, 'www.cakephp.org'); ### Any URI cors($request, '*'); ### Whitelist of URIs cors($request, ['http://www.cakephp.org', '*.google.com', 'https://myproject.github.io']); *Note* The $allowedDomains, $allowedMethods, $allowedHeaders parameters are deprecated. Instead the builder object should be used.
public cors ( Cake\Network\Request $request, string | array $allowedDomains = [], string | array $allowedMethods = [], string | array $allowedHeaders = [] ) : Cake\Network\CorsBuilder
$request Cake\Network\Request Request object
$allowedDomains string | array List of allowed domains, see method description for more details
$allowedMethods string | array List of HTTP verbs allowed
$allowedHeaders string | array List of HTTP headers allowed
return Cake\Network\CorsBuilder A builder object the provides a fluent interface for defining additional CORS headers.

disableCache() public method

Sets the correct headers to instruct the client to not cache the response
public disableCache ( ) : void
return void

download() public method

Sets the correct headers to instruct the browser to download the response as a file.
public download ( string $filename ) : void
$filename string The name of the file as the browser will download the response
return void

etag() public method

Second parameter is used to instruct clients that the content has changed, but semantically, it can be used as the same thing. Think for instance of a page with a hit counter, two different page views are equivalent, but they differ by a few bytes. This leaves off to the Client the decision of using or not the cached page. If no parameters are passed, current Etag header is returned.
public etag ( string | null $hash = null, boolean $weak = false ) : string | null
$hash string | null The unique hash that identifies this response
$weak boolean Whether the response is semantically the same as other with the same hash or not
return string | null

expires() public method

### Examples: $response->expires('now') Will Expire the response cache now $response->expires(new DateTime('+1 day')) Will set the expiration in next 24 hours $response->expires() Will return the current expiration header value
public expires ( string | DateTime | null $time = null ) : string | null
$time string | DateTime | null Valid time string or \DateTime instance.
return string | null

file() public method

If $_SERVER['HTTP_RANGE'] is set a slice of the file will be returned instead of the entire file. ### Options keys - name: Alternate download name - download: If true sets download header and forces file to be downloaded rather than displayed in browser
public file ( string $path, array $options = [] ) : void
$path string Path to file. If the path is not an absolute path that resolves to a file, `APP` will be prepended to the path.
$options array Options See above.
return void

getFile() public method

Get the current file if one exists.
public getFile ( ) : Cake\Filesystem\File | null
return Cake\Filesystem\File | null The file to use in the response or null

getMimeType() public method

e.g getMimeType('pdf'); // returns 'application/pdf'
public getMimeType ( string $alias ) : mixed
$alias string the content type alias to map
return mixed String mapped mime type or false if $alias is not mapped

header() public method

### Single header header('Location', 'http://example.com'); ### Multiple headers header(['Location' => 'http://example.com', 'X-Extra' => 'My header']); ### String header header('WWW-Authenticate: Negotiate'); ### Array of string headers header(['WWW-Authenticate: Negotiate', 'Content-type: application/pdf']); Multiple calls for setting the same header name will have the same effect as setting the header once with the last value sent for it header('WWW-Authenticate: Negotiate'); header('WWW-Authenticate: Not-Negotiate'); will have the same effect as only doing header('WWW-Authenticate: Not-Negotiate');
public header ( string | array | null $header = null, string | array | null $value = null ) : array
$header string | array | null An array of header strings or a single header string - an associative array of "header name" => "header value" is also accepted - an array of string headers is also accepted
$value string | array | null The header value(s)
return array List of headers to be sent

httpCodes() public method

Queries & sets valid HTTP response codes & messages.
public httpCodes ( integer | array | null $code = null ) : mixed
$code integer | array | null If $code is an integer, then the corresponding code/message is returned if it exists, null if it does not exist. If $code is an array, then the keys are used as codes and the values as messages to add to the default HTTP codes. The codes must be integers greater than 99 and less than 1000. Keep in mind that the HTTP specification outlines that status codes begin with a digit between 1 and 5, which defines the class of response the client is to expect. Example: httpCodes(404); // returns [404 => 'Not Found'] httpCodes([ 381 => 'Unicorn Moved', 555 => 'Unexpected Minotaur' ]); // sets these new values, and returns true httpCodes([ 0 => 'Nothing Here', -1 => 'Reverse Infinity', 12345 => 'Universal Password', 'Hello' => 'World' ]); // throws an exception due to invalid codes For more on HTTP status codes see: http://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html#sec6.1
return mixed Associative array of the HTTP codes as keys, and the message strings as values, or null of the given $code does not exist.

length() public method

Sets the Content-Length header for the response If called with no arguments returns the last Content-Length set
public length ( integer | null $bytes = null ) : integer | null
$bytes integer | null Number of bytes
return integer | null

location() public method

Get/Set the Location header value.
public location ( null | string $url = null ) : string | null
$url null | string Either null to get the current location, or a string to set one.
return string | null When setting the location null will be returned. When reading the location a string of the current location header value (if any) will be returned.

mapType() public method

e.g mapType('application/pdf'); // returns 'pdf'
public mapType ( string | array $ctype ) : string | array | null
$ctype string | array Either a string content type to map, or an array of types.
return string | array | null Aliases for the types provided.

maxAge() public method

The max-age is the number of seconds after which the response should no longer be considered a good candidate to be fetched from the local (client) cache. If called with no parameters, this function will return the current max-age value if any
public maxAge ( integer | null $seconds = null ) : integer | null
$seconds integer | null if null, the method will return the current max-age value
return integer | null

modified() public method

### Examples: $response->modified('now') Will set the Last-Modified to the current time $response->modified(new DateTime('+1 day')) Will set the modification date in the past 24 hours $response->modified() Will return the current Last-Modified header value
public modified ( string | DateTime | null $time = null ) : string | null
$time string | DateTime | null Valid time string or \DateTime instance.
return string | null

mustRevalidate() public method

must-revalidate indicates that the response should not be served stale by a cache under any circumstance without first revalidating with the origin. If called with no parameters, this function will return whether must-revalidate is present.
public mustRevalidate ( boolean | null $enable = null ) : boolean
$enable boolean | null if null, the method will return the current must-revalidate value. If boolean sets or unsets the directive.
return boolean

notModified() public method

Sets the response as Not Modified by removing any body contents setting the status code to "304 Not Modified" and removing all conflicting headers
public notModified ( ) : void
return void

outputCompressed() public method

Returns whether the resulting output will be compressed by PHP
public outputCompressed ( ) : boolean
return boolean

protocol() public method

Sets the protocol to be used when sending the response. Defaults to HTTP/1.1 If called with no arguments, it will return the current configured protocol
public protocol ( string | null $protocol = null ) : string
$protocol string | null Protocol to be used for sending response.
return string Protocol currently set

send() public method

Will echo out the content in the response body.
public send ( ) : void
return void

sendHeaders() public method

Sends the HTTP headers and cookies.
public sendHeaders ( ) : void
return void

sharable() public method

Sets whether a response is eligible to be cached by intermediate proxies This method controls the public or private directive in the Cache-Control header
public sharable ( boolean | null $public = null, integer | null $time = null ) : boolean | null
$public boolean | null If set to true, the Cache-Control header will be set as public if set to false, the response will be set to private if no value is provided, it will return whether the response is sharable or not
$time integer | null time in seconds after which the response should no longer be considered fresh
return boolean | null

sharedMaxAge() public method

The max-age is the number of seconds after which the response should no longer be considered a good candidate to be fetched from a shared cache (like in a proxy server). If called with no parameters, this function will return the current max-age value if any
public sharedMaxAge ( integer | null $seconds = null ) : integer | null
$seconds integer | null if null, the method will return the current s-maxage value
return integer | null

statusCode() public method

Sets the HTTP status code to be sent if $code is null the current code is returned
public statusCode ( integer | null $code = null ) : integer
$code integer | null the HTTP status code
return integer Current status code

stop() public method

Stop execution of the current script. Wraps exit() making testing easier.
public stop ( integer | string $status ) : void
$status integer | string See http://php.net/exit for values
return void

type() public method

### Setting the content type type('jpg'); ### Returning the current content type type(); ### Storing content type definitions type(['keynote' => 'application/keynote', 'bat' => 'application/bat']); ### Replacing a content type definition type(['jpg' => 'text/plain']);
public type ( string | null $contentType = null ) : mixed
$contentType string | null Content type key.
return mixed Current content type or false if supplied an invalid content type

vary() public method

Sets the Vary header for the response, if an array is passed, values will be imploded into a comma separated string. If no parameters are passed, then an array with the current Vary header value is returned
public vary ( string | array | null $cacheVariances = null ) : array | null
$cacheVariances string | array | null A single Vary string or an array containing the list for variances.
return array | null

Property Details

$_body protected property

Buffer string or callable for response message
protected string|callable $_body
return string | callable

$_cacheDirectives protected property

Holds all the cache directives that will be converted into headers when sending the request
protected array $_cacheDirectives
return array

$_charset protected property

The charset the response body is encoded with
protected string $_charset
return string

$_contentType protected property

Content type to send. This can be an 'extension' that will be transformed using the $_mimetypes array or a complete mime-type
protected string $_contentType
return string

$_cookies protected property

Holds cookies to be sent to the client
protected array $_cookies
return array

$_file protected property

File object for file to be read out as response
protected File,Cake\Filesystem $_file
return Cake\Filesystem\File

$_fileRange protected property

File range. Used for requesting ranges of files.
protected array $_fileRange
return array

$_headers protected property

Buffer list of headers
protected array $_headers
return array

$_mimeTypes protected property

Holds type key to mime type mappings for known mime types.
protected array $_mimeTypes
return array

$_protocol protected property

Protocol header to send to the client
protected string $_protocol
return string

$_status protected property

Status code to send to the client
protected int $_status
return integer

$_statusCodes protected property

Holds HTTP response statuses
protected array $_statusCodes
return array