A response class intended for test cases.
_body
, _cacheDirectives
, _charset
, _contentType
, _cookies
, _file
, _fileRange
, _headers
, _mimeTypes
, _protocol
, _status
, _statusCodes
send( )
Stub the send() method so headers and output are not sent.
Cake\Network\Response::send()
__construct( array $options [] )
Constructor
$options
optional [] 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
__toString( )
String conversion. Fetches the response body as a string. Does not send headers. If body is a callable, a blank string is returned.
_clearBuffer( )
Clears the contents of the topmost output buffer and discards them
_fileRange( Cake\Filesystem\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.
Cake\Filesystem\File
$file
$httpRange
_flushBuffer( )
Flushes the contents of the output buffer
_getUTCDate( string|integer|DateTime|null $time null )
Returns a DateTime object initialized at the $time param and using UTC as timezone
$time
optional null _sendContent( string|callable $content )
Sends a content string to the client.
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.
$content
String to send as response body or callable which returns/outputs content.
_sendFile( Cake\Filesystem\File $file , array $range )
Reads out a file, and echos the content to the client.
Cake\Filesystem\File
$file
$range
_sendHeader( string $name , string|null $value null )
Sends a header to the client.
$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
_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 Cake\Network\Response::cookie() before any other output is sent to the client. Will set the cookies in the order they have been set.
body( string|callable|null $content null )
Buffers the response message to be sent if $content is null the current buffer is returned
$content
optional null cache( 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|null $charset null )
Sets the response charset if $charset is null the current charset is returned
$charset
optional null checkNotModified( Cake\Network\Request $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.
Cake\Network\Request
$request
compress( )
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 )
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 (when setting a configuration) - name: The Cookie name - value: Value of the cookie - expire: Time the cookie expires in - path: Path the cookie applies to - domain: Domain the cookie is for. - secure: Is the cookie https? - httpOnly: Is the cookie available in the client?
$this->cookie()
$this->cookie('MyCookie')
$this->cookie((array) $options)
$options
optional null Either null to get all cookies, string for a specific cookie or array to set cookie.
cors( Cake\Network\Request $request , string|array $allowedDomains [] , string|array $allowedMethods [] , string|array $allowedHeaders [] )
Setup access for origin and methods on cross origin requests
This method allow multiple ways to setup the domains, see the examples
cors($request, 'http://www.cakephp.org');
cors($request, 'http://*.cakephp.org');
cors($request, 'www.cakephp.org');
cors($request, '*');
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.
Cake\Network\Request
$request
$allowedDomains
optional [] $allowedMethods
optional [] $allowedHeaders
optional [] Cake\Network\CorsBuilder
A builder object the provides a fluent interface for defining additional CORS headers.
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|null $hash 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 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.
$hash
optional null $weak
optional false Whether the response is semantically the same as other with the same hash or not
expires( string|DateTime|null $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 file( string $path , array $options [] )
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
Path to file. If the path is not an absolute path that resolves to a file, APP
will be prepended to the path.
$options
optional [] Cake\Network\Exception\NotFoundException
getFile( )
Get the current file if one exists.
Cake\Filesystem\File
|nullgetMimeType( string $alias )
Returns the mime type definition for an alias
e.g getMimeType('pdf'); // returns 'application/pdf'
$alias
header( string|array|null $header null , string|array|null $value null )
Buffers a header string to be sent Returns the complete list of buffered headers
header('Location', 'http://example.com');
header(['Location' => 'http://example.com', 'X-Extra' => 'My header']);
header('WWW-Authenticate: Negotiate');
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');
$header
optional 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
optional null httpCodes( integer|array|null $code null )
Queries & sets valid HTTP response codes & messages.
$code
optional 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
Associative array of the HTTP codes as keys, and the message strings as values, or null of the given $code does not exist.
length( integer|null $bytes null )
Sets the Content-Length header for the response If called with no arguments returns the last Content-Length set
$bytes
optional null location( null|string $url null )
Accessor for the location header.
Get/Set the Location header value.
$url
optional 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( string|array $ctype )
Maps a content-type back to an alias
e.g mapType('application/pdf'); // returns 'pdf'
$ctype
maxAge( integer|null $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 modified( string|DateTime|null $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 mustRevalidate( boolean|null $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 if null, the method will return the current must-revalidate value. If boolean sets or unsets the directive.
notModified( )
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
protocol( string|null $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 sharable( boolean|null $public null , integer|null $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 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
optional null sharedMaxAge( integer|null $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 statusCode( integer|null $code null )
Sets the HTTP status code to be sent if $code is null the current code is returned
$code
optional null stop( integer|string $status 0 )
Stop execution of the current script. Wraps exit() making testing easier.
$status
optional 0 type( string|null $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
type('jpg');
type();
type(['keynote' => 'application/keynote', 'bat' => 'application/bat']);
type(['jpg' => 'text/plain']);
$contentType
optional null vary( string|array|null $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 A single Vary string or an array containing the list for variances.
© 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/3.2/class-Cake.TestSuite.Stub.Response.html