CakeResponse is responsible for managing the response text, status and headers of a HTTP 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.
__construct( array $options array() )
Constructor
$options optional array() __toString( )
String conversion. Fetches the response body as a string. Does not send headers.
string_clearBuffer( )
Clears the contents of the topmost output buffer and discards them
boolean_fileRange( File $file , string $httpRange )
Apply a file range to a file and set the end offset.
If an invalid range is requested a 416 Status code will be used in the response.
File $file $httpRange _getUTCDate( string|DateTime $time null )
Returns a DateTime object initialized at the $time param and using UTC as timezone
$time optional null DateTime_isActive( )
Returns true if connection is still active
boolean_normalizeCorsDomains( array $domains , boolean $requestIsSSL false )
Normalize the origin to regular expressions and put in an array format
$domains $requestIsSSL optional false array_sendContent( string $content )
Sends a content string to the client.
$content _sendFile( File $file , array $range )
Reads out a file, and echos the content to the client.
File $file $range boolean_sendHeader( string $name , string $value null )
Sends a header to the client.
Will skip sending headers if headers have already been sent.
$name $value optional null _setCacheControl( )
Helper method to generate a valid Cache-Control header from the options set in other methods
_setContent( )
Sets the response body to an empty text if the status code is 204 or 304
_setContentLength( )
Calculates the correct Content-Length and sets it as a header in the response Will not set the value if already set or if the output is compressed.
_setContentType( )
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( )
Sets the cookies that have been added via CakeResponse::cookie() before any other output is sent to the client. Will set the cookies in the order they have been set.
body( string $content null )
Buffers the response message to be sent if $content is null the current buffer is returned
$content optional null stringcache( string $since , string $time '+1 day' )
Sets the correct headers to instruct the client to cache the response.
$since $time optional '+1 day' charset( string $charset null )
Sets the response charset if $charset is null the current charset is returned
$charset optional null stringcheckNotModified( CakeRequest $request )
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.
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.
CakeRequest $request booleancompress( )
Sets the correct output buffering handler to send a compressed response. Responses will be compressed with zlib, if the extension is available.
booleancookie( array $options null )
Getter/Setter for cookie configs
This method acts as a setter/getter depending on the type of the argument. If the method is called with no arguments, it returns all configurations.
If the method is called with a string as argument, it returns either the given configuration if it is set, or null, if it's not set.
If the method is called with an array as argument, it will set the cookie configuration to the cookie container.
$options optional null $this->cookie() ### Getting a certain cookie configuration $this->cookie('MyCookie') ### Setting a cookie configuration $this->cookie((array) $options)
mixedcors( CakeRequest $request , string|array $allowedDomains , string|array $allowedMethods array() , string|array $allowedHeaders array() )
Setup access for origin and methods on cross origin requests
This method allow multiple ways to setup the domains, see the examples
e.g cors($request, 'http://www.cakephp.org');
e.g cors($request, 'http://*.cakephp.org');
e.g cors($request, 'www.cakephp.org');
e.g cors($request, '*');
e.g cors($request, array('http://www.cakephp.org', '*.google.com', 'https://myproject.github.io'));
CakeRequest $request $allowedDomains $allowedMethods optional array() $allowedHeaders optional array() disableCache( )
Sets the correct headers to instruct the client to not cache the response
download( string $filename )
Sets the correct headers to instruct the browser to download the response as a file.
$filename etag( string $tag null , boolean $weak false )
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.
Second parameter is used to instruct clients that the content has changed, but sematicallly, 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.
$tag optional null $weak optional false stringexpires( string|DateTime $time 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
$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
$time optional null stringfile( string $path , array $options array() )
Setup for display or download the given file.
If $_SERVER['HTTP_RANGE'] is set a slice of the file will be returned instead of the entire file.
true sets download header and forces file to be downloaded rather than displayed in browser$path APP will be prepended to the path.$options optional array() NotFoundExceptiongetMimeType( string $alias )
Returns the mime type definition for an alias
e.g getMimeType('pdf'); // returns 'application/pdf'
$alias mixedheader( string|array $header null , string|array $value null )
Buffers a header string to be sent Returns the complete list of buffered headers
e.g header('Location', 'http://example.com');
e.g header(array('Location' => 'http://example.com', 'X-Extra' => 'My header'));
e.g header('WWW-Authenticate: Negotiate');
e.g header(array('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 e.g header('WWW-Authenticate: Negotiate'); header('WWW-Authenticate: Not-Negotiate'); will have the same effect as only doing header('WWW-Authenticate: Not-Negotiate');
$header optional null $value optional null arrayhttpCodes( integer|array $code null )
Queries & sets valid HTTP response codes & messages.
$code optional null mixedCakeExceptionlength( integer $bytes null )
Sets the Content-Length header for the response If called with no arguments returns the last Content-Length set
$bytes optional null integer|nulllocation( null|string $url null )
Accessor for the location header.
Get/Set the Location header value.
$url optional null string|nullmapType( string|array $ctype )
Maps a content-type back to an alias
e.g mapType('application/pdf'); // returns 'pdf'
$ctype mixedmaxAge( integer $seconds null )
Sets the Cache-Control max-age directive. 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
$seconds optional null integermodified( string|DateTime $time 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
$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
$time optional null stringmustRevalidate( boolean $enable null )
Sets the Cache-Control must-revalidate directive. 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.
$enable optional null booleannotModified( )
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( )
Returns whether the resulting output will be compressed by PHP
booleanprotocol( string $protocol null )
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
$protocol optional null stringsend( )
Sends the complete response to the client including headers and message body. Will echo out the content in the response body.
sharable( boolean $public null , integer $time 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
$public optional null $time optional null booleansharedMaxAge( integer $seconds null )
Sets the Cache-Control s-maxage directive. 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
$seconds optional null integerstatusCode( integer $code null )
Sets the HTTP status code to be sent if $code is null the current code is returned
$code optional null integerCakeExceptiontype( string $contentType null )
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
e.g type('jpg');
e.g type();
e.g type(array('keynote' => 'application/keynote', 'bat' => 'application/bat'));
e.g type(array('jpg' => 'text/plain'));
$contentType optional null mixedvary( string|array $cacheVariances 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
$cacheVariances optional null array
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/2.7/class-CakeResponse.html