Class Cake\TestSuite\Stub\Response

__construct() public ¶

__construct( array $options [] )

Constructor

Parameters

array $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

__debugInfo() public ¶

__debugInfo( )

Returns an array that can be used to describe the internal state of this object.

Returns

array

__toString() public ¶

__toString( )

String conversion. Fetches the response body as a string. Does not send headers. If body is a callable, a blank string is returned.

Returns

string

_clearBuffer() protected ¶

_clearBuffer( )

Clears the contents of the topmost output buffer and discards them

Deprecated

3.2.4 This function is not needed anymore

Returns

boolean

_clearHeader() protected ¶

_clearHeader( string $header )

Clear header

Parameters

string $header: Header key.

_createStream() protected ¶

_createStream( )

Creates the stream object.

_fileRange() protected ¶

_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.

Deprecated

3.4.0 Long term this needs to be refactored to follow immutable paradigms. However for now, it is simpler to leave this alone.

Parameters

Cake\Filesystem\File $file: The file to set a range on.
string $httpRange: The range to use.

_flushBuffer() protected ¶

_flushBuffer( )

Flushes the contents of the output buffer

Deprecated

3.2.4 This function is not needed anymore

_getUTCDate() protected ¶

_getUTCDate( string|integer|DateTimeInterface|null $time null )

Returns a DateTime object initialized at the $time param and using UTC as timezone

Parameters

string|integer|DateTimeInterface|null $time optional null: Valid time string or \DateTimeInterface instance.

Returns

DateTimeInterface

_handleCallableBody() protected ¶

_handleCallableBody( callable $content )

Handles the callable body for backward compatibility reasons.

Parameters

callable $content: Callable content.

Returns

string

_isActive() protected ¶

_isActive( )

Returns true if connection is still active

Deprecated

3.4.0 Will be removed in 4.0.0

Returns

boolean

_sendContent() protected ¶

_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.

Deprecated

3.4.0 Will be removed in 4.0.0

Parameters

string|callable $content: String to send as response body or callable which returns/outputs content.

_sendFile() protected ¶

_sendFile( Cake\Filesystem\File $file , array $range )

Reads out a file, and echos the content to the client.

Deprecated

3.4.0 Will be removed in 4.0.0

Parameters

Cake\Filesystem\File $file: File object
array $range: The range to read out of the file.

Returns

boolean
True is whole file is echoed successfully or false if client connection is lost in between

_sendHeader() protected ¶

_sendHeader( string $name , string|null $value null )

Sends a header to the client.

Deprecated

3.4.0 Will be removed in 4.0.0

Parameters

string $name: the header name
string|null $value optional null: the header value

_setCacheControl() protected ¶

_setCacheControl( )

Helper method to generate a valid Cache-Control header from the options set in other methods

_setContent() protected ¶

_setContent( )

Sets the response body to an empty text if the status code is 204 or 304

Deprecated

3.4.0 Will be removed in 4.0.0

_setContentType() protected ¶

_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() protected ¶

_setCookies( )

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

Deprecated

3.4.0 Will be removed in 4.0.0

_setHeader() protected ¶

_setHeader( string $header , string $value )

Sets a header.

Parameters

string $header: Header key.
string $value: Header value.

_setStatus() protected ¶

_setStatus( integer $code , string $reasonPhrase '' )

Modifier for response status

Parameters

integer $code: The code to set.
string $reasonPhrase optional '': The response reason phrase.

Throws

InvalidArgumentException
For invalid status code arguments.

body() public ¶

body( string|callable|null $content null )

Buffers the response message to be sent if $content is null the current buffer is returned

Deprecated

3.4.0 Mutable response methods are deprecated. Use withBody()/withStringBody() and getBody() instead.

Parameters

string|callable|null $content optional null: the string or callable message to be sent

Returns

string|null
Current message buffer if $content param is passed as null

cache() public ¶

cache( string $since , string $time '+1 day' )

Sets the correct headers to instruct the client to cache the response.

Deprecated

3.4.0 Use withCache() instead.

Parameters

string $since: a valid time since the response text has not been modified
string $time optional '+1 day': a valid time for cache expiry

charset() public ¶

charset( string|null $charset null )

Sets the response charset if $charset is null the current charset is returned

Deprecated

3.5.0 Use getCharset()/withCharset() instead.

Parameters

string|null $charset optional null: Character set string.

Returns

string
Current charset

checkNotModified() public ¶

checkNotModified( Cake\Http\ServerRequest $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.

Warning This method mutates the response in-place and should be avoided.

Parameters

Cake\Http\ServerRequest $request: Request object

Returns

boolean
Whether the response was marked as not modified or not.

compress() public ¶

compress( )

Sets the correct output buffering handler to send a compressed response. Responses will be compressed with zlib, if the extension is available.

Returns

boolean
false if client does not accept compressed responses or no handler is available, true otherwise

convertCookieToArray() protected ¶

convertCookieToArray( Cake\Http\Cookie\CookieInterface $cookie )

Convert the cookie into an array of its properties.

This method is compatible with the historical behavior of Cake\Http\Response, where httponly is httpOnly and expires is expire

Parameters

Cake\Http\Cookie\CookieInterface $cookie: Cookie object.

Returns

array

cookie() public ¶

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?

Examples

Getting all cookies

$this->cookie()

Getting a certain cookie configuration

$this->cookie('MyCookie')

Setting a cookie configuration

$this->cookie((array) $options)

Deprecated

3.4.0 Use getCookie(), getCookies() and withCookie() instead.

Parameters

array|null $options optional null: Either null to get all cookies, string for a specific cookie or array to set cookie.

Returns

mixed

cors() public ¶

cors( Cake\Http\ServerRequest $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

Full URI

cors($request, 'https://www.cakephp.org');

URI with wildcard

cors($request, 'https://*.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.

Parameters

Cake\Http\ServerRequest $request: Request object
string|array $allowedDomains optional []: List of allowed domains, see method description for more details
string|array $allowedMethods optional []: List of HTTP verbs allowed
string|array $allowedHeaders optional []: List of HTTP headers allowed

Returns

Cake\Http\CorsBuilder

A builder object the provides a fluent interface for defining additional CORS headers.

disableCache() public ¶

disableCache( )

Sets the correct headers to instruct the client to not cache the response

Deprecated

3.4.0 Use withDisabledCache() instead.

download() public ¶

download( string $filename )

Sets the correct headers to instruct the browser to download the response as a file.

Deprecated

3.4.0 Use withDownload() instead.

Parameters

string $filename: The name of the file as the browser will download the response

etag() public ¶

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.

Deprecated

3.4.0 Use withEtag() instead.

Parameters

string|null $hash optional null: The unique hash that identifies this response
boolean $weak optional false: Whether the response is semantically the same as other with the same hash or not

Returns

string|null

expires() public ¶

expires( string|DateTimeInterface|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

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

Deprecated

3.4.0 Use withExpires() instead.

Parameters

string|DateTimeInterface|null $time optional null: Valid time string or \DateTime instance.

Returns

string|null

file() public ¶

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.

Options keys

name: Alternate download name
download: If true sets download header and forces file to be downloaded rather than displayed in browser

Deprecated

3.4.0 Use withFile() instead.

Parameters

string $path: Path to file. If the path is not an absolute path that resolves to a file, APP will be prepended to the path (this behavior is deprecated).
array $options optional []: Options See above.

Throws

Cake\Http\Exception\NotFoundException

getCharset() public ¶

getCharset( )

Returns the current charset.

Returns

string

getCookie() public ¶

getCookie( string $name )

Read a single cookie from the response.

This method provides read access to pending cookies. It will not read the Set-Cookie header if set.

Parameters

string $name: The cookie name you want to read.

Returns

array|null
Either the cookie data or null

getCookieCollection() public ¶

getCookieCollection( )

Get the CookieCollection from the response

Returns

Cake\Http\Cookie\CookieCollection

getCookies() public ¶

getCookies( )

Get all cookies in the response.

Returns an associative array of cookie name => cookie data.

Returns

array

getFile() public ¶

getFile( )

Get the current file if one exists.

Returns

Cake\Filesystem\File|null
The file to use in the response or null

getMimeType() public ¶

getMimeType( string $alias )

Returns the mime type definition for an alias

e.g getMimeType('pdf'); // returns 'application/pdf'

Parameters

string $alias: the content type alias to map

Returns

mixed
String mapped mime type or false if $alias is not mapped

getReasonPhrase() public ¶

getReasonPhrase( )

Gets the response reason phrase associated with the status code.

Because a reason phrase is not a required element in a response status line, the reason phrase value MAY be null. Implementations MAY choose to return the default RFC 7231 recommended reason phrase (or those listed in the IANA HTTP Status Code Registry) for the response's status code.

Returns

string
Reason phrase; must return an empty string if none present.

Link

https://tools.ietf.org/html/rfc7231#section-6
http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

getSimpleHeaders() protected ¶

getSimpleHeaders( )

Backwards compatibility helper for getting flattened headers.

Previously CakePHP would store headers as a simple dictionary, now that we're supporting PSR7, the internal storage has each header as an array.

Returns

array

getStatusCode() public ¶

getStatusCode( )

Gets the response status code.

The status code is a 3-digit integer result code of the server's attempt to understand and satisfy the request.

Returns

integer
Status code.

getType() public ¶

getType( )

Returns the current content type.

Returns

string

header() public ¶

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

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');

Deprecated

3.4.0 Use withHeader(), getHeaderLine() and getHeaders() instead.

Parameters

string|array|null $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
string|array|null $value optional null: The header value(s)

Returns

array
List of headers to be sent

httpCodes() public ¶

httpCodes( integer|array|null $code null )

Queries & sets valid HTTP response codes & messages.

Deprecated

3.4.0 Will be removed in 4.0.0

Parameters

integer|array|null $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

Returns

mixed

Associative array of the HTTP codes as keys, and the message strings as values, or null of the given $code does not exist.

Throws

InvalidArgumentException
If an attempt is made to add an invalid status code

length() public ¶

length( integer|null $bytes null )

Sets the Content-Length header for the response If called with no arguments returns the last Content-Length set

Deprecated

3.4.0 Use withLength() to set length instead.

Parameters

integer|null $bytes optional null: Number of bytes

Returns

string|null

location() public ¶

location( null|string $url null )

Accessor for the location header.

Get/Set the Location header value.

Deprecated

3.4.0 Mutable responses are deprecated. Use withLocation() and getHeaderLine() instead.

Parameters

null|string $url optional null: Either null to get the current location, or a string to set one.

Returns

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 ¶

mapType( string|array $ctype )

Maps a content-type back to an alias

e.g mapType('application/pdf'); // returns 'pdf'

Parameters

string|array $ctype: Either a string content type to map, or an array of types.

Returns

string|array|null
Aliases for the types provided.

maxAge() public ¶

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

Deprecated

3.6.5 Use withMaxAge() instead.

Parameters

integer|null $seconds optional null: if null, the method will return the current max-age value

Returns

integer|null

modified() public ¶

modified( string|DateTimeInterface|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

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

Deprecated

3.4.0 Use withModified() instead.

Parameters

string|DateTimeInterface|null $time optional null: Valid time string or \DateTime instance.

Returns

string|null

mustRevalidate() public ¶

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.

Deprecated

3.4.0 Use withMustRevalidate() instead.

Parameters

boolean|null $enable optional null: if null, the method will return the current must-revalidate value. If boolean sets or unsets the directive.

Returns

boolean

notModified() public ¶

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

Warning This method mutates the response in-place and should be avoided.

outputCompressed() public ¶

outputCompressed( )

Returns whether the resulting output will be compressed by PHP

Returns

boolean

protocol() public ¶

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

Deprecated

3.4.0 Use getProtocolVersion() instead.

Parameters

string|null $protocol optional null: Protocol to be used for sending response.

Returns

string
Protocol currently set

resolveType() protected ¶

resolveType( string $contentType )

Translate and validate content-types.

Parameters

string $contentType: The content-type or type alias.

Returns

string
The resolved content-type

Throws

InvalidArgumentException
When an invalid content-type or alias is used.

sendHeaders() public ¶

sendHeaders( )

Sends the HTTP headers and cookies.

Deprecated

3.4.0 Will be removed in 4.0.0

setTypeMap() public ¶

setTypeMap( string $type , string|array $mimeType )

Sets a content type definition into the map.

E.g.: setTypeMap('xhtml', ['application/xhtml+xml', 'application/xhtml'])

This is needed for RequestHandlerComponent and recognition of types.

Parameters

string $type: Content type.
string|array $mimeType: Definition of the mime type.

sharable() public ¶

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

Parameters

boolean|null $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
integer|null $time optional null: time in seconds after which the response should no longer be considered fresh

Returns

boolean|null

sharedMaxAge() public ¶

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

Deprecated

3.6.5 Use withSharedMaxAge() instead.

Parameters

integer|null $seconds optional null: if null, the method will return the current s-maxage value

Returns

integer|null

statusCode() public ¶

statusCode( integer|null $code null )

Sets the HTTP status code to be sent if $code is null the current code is returned

If the status code is 304 or 204, the existing Content-Type header will be cleared, as these response codes have no body.

Deprecated

3.4.0 Use getStatusCode() and withStatus() instead.

Parameters

integer|null $code optional null: the HTTP status code

Returns

integer
Current status code

Throws

InvalidArgumentException
When an unknown status code is reached.

stop() public ¶

stop( integer|string $status 0 )

Stop execution of the current script. Wraps exit() making testing easier.

Deprecated

3.4.0 Will be removed in 4.0.0

Parameters

integer|string $status optional 0: See https://secure.php.net/exit for values

type() public ¶

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

Setting the content type

type('jpg');

If you attempt to set the type on a 304 or 204 status code response, the content type will not take effect as these status codes do not have content-types.

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']);

Deprecated

3.5.5 Use getType() or withType() instead.

Parameters

string|null $contentType optional null: Content type key.

Returns

mixed
Current content type or false if supplied an invalid content type.

validateFile() protected ¶

validateFile( string $path )

Validate a file path is a valid response body.

Parameters

string $path: The path to the file.

Returns

Cake\Filesystem\File

Throws

Cake\Http\Exception\NotFoundException

vary() public ¶

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

Deprecated

3.4.0 Use withVary() instead.

Parameters

string|array|null $cacheVariances optional null: A single Vary string or an array containing the list for variances.

Returns

array|null

withAddedLink() public ¶

withAddedLink( string $url , array $options [] )

Create a new response with the Link header set.

Examples

$response = $response->withAddedLink('http://example.com?page=1', ['rel' => 'prev'])
    ->withAddedLink('http://example.com?page=3', ['rel' => 'next']);

Will generate:

Link: <http://example.com?page=1>; rel="prev"
Link: <http://example.com?page=3>; rel="next"

Parameters

string $url: The LinkHeader url.
array $options optional []: The LinkHeader params.

Returns

Cake\Http\Response

Since

3.6.0

withCache() public ¶

withCache( string $since , string $time '+1 day' )

Create a new instance with the headers to enable client caching.

Parameters

string $since: a valid time since the response text has not been modified
string $time optional '+1 day': a valid time for cache expiry

Returns

Cake\Http\Response

withCharset() public ¶

withCharset( string $charset )

Get a new instance with an updated charset.

Parameters

string $charset: Character set string.

Returns

Cake\Http\Response

withCookie() public ¶

withCookie( string|Cake\Http\Cookie\Cookie $name , array|string $data '' )

Create a new response with a cookie set.

Data

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?

Examples

// set scalar value with defaults
$response = $response->withCookie('remember_me', 1);

// customize cookie attributes
$response = $response->withCookie('remember_me', ['path' => '/login']);

// add a cookie object
$response = $response->withCookie(new Cookie('remember_me', 1));

Parameters

string|Cake\Http\Cookie\Cookie $name: The name of the cookie to set, or a cookie object
array|string $data optional '': Either a string value, or an array of cookie options.

Returns

Cake\Http\Response

withDisabledCache() public ¶

withDisabledCache( )

Create a new instance with headers to instruct the client to not cache the response

Returns

Cake\Http\Response

withDownload() public ¶

withDownload( string $filename )

Create a new instance with the Content-Disposition header set.

Parameters

string $filename: The name of the file as the browser will download the response

Returns

Cake\Http\Response

withEtag() public ¶

withEtag( string $hash , boolean $weak false )

Create a new instance with the Etag header set.

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 that makes the response unique.

The second parameter is used to inform clients that the content has changed, but semantically it is equivalent to existing cached values. Consider a page with a hit counter, two different page views are equivalent, but they differ by a few bytes. This permits the Client to decide whether they should use the cached data.

Parameters

string $hash: The unique hash that identifies this response
boolean $weak optional false: Whether the response is semantically the same as other with the same hash or not. Defaults to false

Returns

Cake\Http\Response

withExpiredCookie() public ¶

withExpiredCookie( string|Cake\Http\Cookie\CookieInterface $name , array $options [] )

Create a new response with an expired cookie set.

Options

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?

Examples

// set scalar value with defaults
$response = $response->withExpiredCookie('remember_me');

// customize cookie attributes
$response = $response->withExpiredCookie('remember_me', ['path' => '/login']);

// add a cookie object
$response = $response->withExpiredCookie(new Cookie('remember_me'));

Parameters

string|Cake\Http\Cookie\CookieInterface $name: The name of the cookie to expire, or a cookie object
array $options optional []: An array of cookie options.

Returns

Cake\Http\Response

withExpires() public ¶

withExpires( string|DateTimeInterface $time )

Create a new instance with the Expires header set.

Examples:

// Will Expire the response cache now
$response->withExpires('now')

// Will set the expiration in next 24 hours
$response->withExpires(new DateTime('+1 day'))

Parameters

string|DateTimeInterface $time: Valid time string or \DateTime instance.

Returns

Cake\Http\Response

withFile() public ¶

withFile( string $path , array $options [] )

Create a new instance that is based on a file.

This method will augment both the body and a number of related headers.

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 inline.

Parameters

string $path: Path to file. If the path is not an absolute path that resolves to a file, APP will be prepended to the path (this behavior is deprecated).
array $options optional []: Options See above.

Returns

Cake\Http\Response

Throws

Cake\Http\Exception\NotFoundException

withLength() public ¶

withLength( integer|string $bytes )

Create a new response with the Content-Length header set.

Parameters

integer|string $bytes: Number of bytes

Returns

Cake\Http\Response

withLocation() public ¶

withLocation( string $url )

Return an instance with an updated location header.

If the current status code is 200, it will be replaced with 302.

Parameters

string $url: The location to redirect to.

Returns

Cake\Http\Response
A new response with the Location header set.

withMaxAge() public ¶

withMaxAge( integer $seconds )

Create an instance with Cache-Control max-age directive set.

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.

Parameters

integer $seconds: The seconds a cached response can be considered valid

Returns

Cake\Http\Response

withModified() public ¶

withModified( string|DateTimeInterface $time )

Create a new instance with the Last-Modified header set.

Examples:

// Will Expire the response cache now
$response->withModified('now')

// Will set the expiration in next 24 hours
$response->withModified(new DateTime('+1 day'))

Parameters

string|DateTimeInterface $time: Valid time string or \DateTimeInterface instance.

Returns

Cake\Http\Response

withMustRevalidate() public ¶

withMustRevalidate( boolean $enable )

Create an instance with Cache-Control must-revalidate directive set.

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.

Parameters

boolean $enable: If boolean sets or unsets the directive.

Returns

Cake\Http\Response

withNotModified() public ¶

withNotModified( )

Create a new instance as 'not modified'

This will remove any body contents set the status code to "304" and removing headers that describe a response body.

Returns

Cake\Http\Response

withSharable() public ¶

withSharable( boolean $public , integer|null $time null )

Create a new instace with the public/private Cache-Control directive set.

Parameters

boolean $public: If set to true, the Cache-Control header will be set as public if set to false, the response will be set to private.
integer|null $time optional null: time in seconds after which the response should no longer be considered fresh.

Returns

Cake\Http\Response

withSharedMaxAge() public ¶

withSharedMaxAge( integer $seconds )

Create a new instance with 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).

Parameters

integer $seconds: The number of seconds for shared max-age

Returns

Cake\Http\Response

withStatus() public ¶

withStatus( integer $code , string $reasonPhrase '' )

Return an instance with the specified status code and, optionally, reason phrase.

If no reason phrase is specified, implementations MAY choose to default to the RFC 7231 or IANA recommended reason phrase for the response's status code.

This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that has the updated status and reason phrase.

If the status code is 304 or 204, the existing Content-Type header will be cleared, as these response codes have no body.

Parameters

integer $code: The 3-digit integer result code to set.
string $reasonPhrase optional '': The reason phrase to use with the provided status code; if none is provided, implementations MAY use the defaults as suggested in the HTTP specification.

Returns

Cake\Http\Response

Throws

InvalidArgumentException
For invalid status code arguments.

Link

https://tools.ietf.org/html/rfc7231#section-6
https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

withStringBody() public ¶

withStringBody( string $string )

Convenience method to set a string into the response body

Parameters

string $string: The string to be sent

Returns

Cake\Http\Response

withType() public ¶

withType( string $contentType )

Get an updated response with the content type set.

If you attempt to set the type on a 304 or 204 status code response, the content type will not take effect as these status codes do not have content-types.

Parameters

string $contentType: Either a file extension which will be mapped to a mime-type or a concrete mime-type.

Returns

Cake\Http\Response

withVary() public ¶

withVary( string|array $cacheVariances )

Create a new instance with the Vary header set.

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

Parameters

string|array $cacheVariances: A single Vary string or an array containing the list for variances.

Returns

Cake\Http\Response

Namespaces

Classes

Class Response

Inherited Properties

Method Summary

send() public

Method Detail

send() public ¶

Returns

Overrides

Methods inherited from Cake\Http\Response

__construct() public ¶

Parameters

__debugInfo() public ¶

Returns

__toString() public ¶

Returns

_clearBuffer() protected ¶

Deprecated

Returns

_clearHeader() protected ¶

Parameters

_createStream() protected ¶

_fileRange() protected ¶

Deprecated

Parameters

_flushBuffer() protected ¶

Deprecated

_getUTCDate() protected ¶

Parameters

Returns

_handleCallableBody() protected ¶

Parameters

Returns

_isActive() protected ¶

Deprecated

Returns

_sendContent() protected ¶

Deprecated

Parameters

_sendFile() protected ¶

Deprecated

Parameters

Returns

_sendHeader() protected ¶

Deprecated

Parameters

_setCacheControl() protected ¶

_setContent() protected ¶

Deprecated

_setContentType() protected ¶

_setCookies() protected ¶

Deprecated

_setHeader() protected ¶

Parameters

_setStatus() protected ¶

Parameters

Throws

body() public ¶

Deprecated

Parameters

Returns

cache() public ¶

Deprecated

Parameters

charset() public ¶

Deprecated

Parameters

Returns

checkNotModified() public ¶

Parameters

Returns

compress() public ¶

Returns

convertCookieToArray() protected ¶

Parameters

Returns

cookie() public ¶

Examples

Getting all cookies