• Home
• Cake
• Network
• Response

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

Property Details