$headers
$headers : array
List of all registered headers, as key => array of values.
Responses contain the response text, status and headers of a HTTP response.
$_file : \Cake\Filesystem\File|null
File object for file to be read out as response
$_cookies : \Cake\Http\Cookie\CookieCollection
Collection of cookies to send to the client
$stream : \Psr\Http\Message\StreamInterface
withProtocolVersion(string $version) : static
Return an instance with the specified HTTP protocol version.
The version string MUST contain only the HTTP version number (e.g., "1.1", "1.0").
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 new protocol version.
| string | $version | HTTP protocol version |
getHeaders() : array
Retrieves all message headers.
The keys represent the header name as it will be sent over the wire, and each value is an array of strings associated with the header.
// Represent the headers as a string
foreach ($message->getHeaders() as $name => $values) {
echo $name . ": " . implode(", ", $values);
}
// Emit headers iteratively:
foreach ($message->getHeaders() as $name => $values) {
foreach ($values as $value) {
header(sprintf('%s: %s', $name, $value), false);
}
}Returns an associative array of the message's headers. Each key MUST be a header name, and each value MUST be an array of strings.
hasHeader(string $header) : boolean
Checks if a header exists by the given case-insensitive name.
| string | $header | Case-insensitive header name. |
Returns true if any header names match the given header name using a case-insensitive string comparison. Returns false if no matching header name is found in the message.
getHeader(string $header) : array<mixed,string>
Retrieves a message header value by the given case-insensitive name.
This method returns an array of all the header values of the given case-insensitive header name.
If the header does not appear in the message, this method MUST return an empty array.
| string | $header | Case-insensitive header field name. |
An array of string values as provided for the given header. If the header does not appear in the message, this method MUST return an empty array.
getHeaderLine(string $name) : string
Retrieves a comma-separated string of the values for a single header.
This method returns all of the header values of the given case-insensitive header name as a string concatenated together using a comma.
NOTE: Not all header values may be appropriately represented using comma concatenation. For such headers, use getHeader() instead and supply your own delimiter when concatenating.
If the header does not appear in the message, this method MUST return an empty string.
| string | $name | Case-insensitive header field name. |
A string of values as provided for the given header concatenated together using a comma. If the header does not appear in the message, this method MUST return an empty string.
withHeader(string $header, string|array<mixed,string> $value) : static
Return an instance with the provided header, replacing any existing values of any headers with the same case-insensitive name.
While header names are case-insensitive, the casing of the header will be preserved by this function, and returned from getHeaders().
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 new and/or updated header and value.
| string | $header | Case-insensitive header field name. |
| string|array<mixed,string> | $value | Header value(s). |
for invalid header names or values.
withAddedHeader(string $header, string|array<mixed,string> $value) : static
Return an instance with the specified header appended with the given value.
Existing values for the specified header will be maintained. The new value(s) will be appended to the existing list. If the header did not exist previously, it will be added.
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 new header and/or value.
| string | $header | Case-insensitive header field name to add. |
| string|array<mixed,string> | $value | Header value(s). |
for invalid header names or values.
withoutHeader(string $header) : static
Return an instance without the specified header.
Header resolution MUST be done without case-sensitivity.
This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return an instance that removes the named header.
| string | $header | Case-insensitive header field name to remove. |
getBody() : \Psr\Http\Message\StreamInterface
Gets the body of the message.
Returns the body as a stream.
withBody(\Psr\Http\Message\StreamInterface $body) : static
Return an instance with the specified message body.
The body MUST be a StreamInterface object.
This method MUST be implemented in such a way as to retain the immutability of the message, and MUST return a new instance that has the new body stream.
| \Psr\Http\Message\StreamInterface | $body | Body. |
When the body is not valid.
__construct(array $options = array())
Constructor
| array | $options | list of parameters to setup the response. Possible values are:
|
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
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');| string|array|null | $header | An array of header strings or a single header string
|
| string|array|null | $value | The header value(s) |
List of headers to be sent
location(null|string $url = null) : string|null
Accessor for the location header.
Get/Set the Location header value.
| null|string | $url | Either null to get the current location, or a string to set one. |
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.
body(string|callable|null $content = null) : string|null
Buffers the response message to be sent if $content is null the current buffer is returned
| string|callable|null | $content | the string or callable message to be sent |
Current message buffer if $content param is passed as null
statusCode(integer|null $code = null) : integer
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.
| integer|null | $code | the HTTP status code |
When an unknown status code is reached.
Current status code
withStatus(integer $code, string $reasonPhrase = '') : static
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.
| integer | $code | The 3-digit integer result code to set. |
| string | $reasonPhrase | 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. |
For invalid status code arguments.
getReasonPhrase() : string
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.
Reason phrase; must return an empty string if none present.
httpCodes(integer|array|null $code = null) : mixed
Queries & sets valid HTTP response codes & messages.
| integer|array|null | $code | 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: |
If an attempt is made to add an invalid status code
Associative array of the HTTP codes as keys, and the message strings as values, or null of the given $code does not exist.
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
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.
type();type(['keynote' => 'application/keynote', 'bat' => 'application/bat']);type(['jpg' => 'text/plain']);| string|null | $contentType | Content type key. |
Current content type or false if supplied an invalid content type.
setTypeMap(string $type, string|array $mimeType) : void
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.
| string | $type | Content type. |
| string|array | $mimeType | Definition of the mime type. |
withType(string $contentType) : static
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.
| string | $contentType | Either a file extension which will be mapped to a mime-type or a concrete mime-type. |
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
| boolean|null | $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 if no value is provided, it will return whether the response is sharable or not |
| integer|null | $time | time in seconds after which the response should no longer be considered fresh |
withSharable(boolean $public, integer|null $time = null) : static
Create a new instace with the public/private Cache-Control directive set.
| 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 | time in seconds after which the response should no longer be considered fresh. |
sharedMaxAge(integer|null $seconds = null) : integer|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
| integer|null | $seconds | if null, the method will return the current s-maxage value |
withSharedMaxAge(integer $seconds) : static
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).
| integer | $seconds | The number of seconds for shared max-age |
maxAge(integer|null $seconds = null) : integer|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
| integer|null | $seconds | if null, the method will return the current max-age value |
withMaxAge(integer $seconds) : static
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.
| integer | $seconds | The seconds a cached response can be considered valid |
mustRevalidate(boolean|null $enable = null) : boolean
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.
| boolean|null | $enable | if null, the method will return the current must-revalidate value. If boolean sets or unsets the directive. |
withMustRevalidate(boolean $enable) : static
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.
| boolean | $enable | If boolean sets or unsets the directive. |
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
$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
| string|\DateTime|null | $time | Valid time string or \DateTime instance. |
withExpires(string|\DateTime $time) : static
Create a new instance with the Expires header set.
// Will Expire the response cache now
$response->withExpires('now')
// Will set the expiration in next 24 hours
$response->withExpires(new DateTime('+1 day'))| string|\DateTime | $time | Valid time string or \DateTime instance. |
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
$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
| string|\DateTime|null | $time | Valid time string or \DateTime instance. |
withModified(string|\DateTime $time) : static
Create a new instance with the Last-Modified header set.
// Will Expire the response cache now
$response->withModified('now')
// Will set the expiration in next 24 hours
$response->withModified(new DateTime('+1 day'))| string|\DateTime | $time | Valid time string or \DateTime instance. |
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
| string|array|null | $cacheVariances | A single Vary string or an array containing the list for variances. |
withVary(string|array $cacheVariances) : static
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
| string|array | $cacheVariances | A single Vary string or an array containing the list for variances. |
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.
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.
| string|null | $hash | The unique hash that identifies this response |
| boolean | $weak | Whether the response is semantically the same as other with the same hash or not |
withEtag(string $hash, boolean $weak = false) : static
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.
| string | $hash | The unique hash that identifies this response |
| boolean | $weak | Whether the response is semantically the same as other with the same hash or not. Defaults to false |
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
| string|null | $protocol | Protocol to be used for sending response. |
Protocol currently set
withAddedLink(string $url, array $options = array()) : static
Create a new response with the Link header set.
$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"| string | $url | The LinkHeader url. |
| array | $options | The LinkHeader params. |
checkNotModified(\Cake\Http\ServerRequest $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.
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.
| \Cake\Http\ServerRequest | $request | Request object |
Whether the response was marked as not modified or not.
cookie(array|null $options = null) : mixed
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.
$this->cookie()
$this->cookie('MyCookie')
$this->cookie((array) $options)
| array|null | $options | Either null to get all cookies, string for a specific cookie or array to set cookie. |
withCookie(string|\Cake\Http\Cookie\Cookie $name, array|string $data = '') : static
Create a new response with a cookie set.
value: Value of the cookieexpire: Time the cookie expires inpath: Path the cookie applies todomain: Domain the cookie is for.secure: Is the cookie https?httpOnly: Is the cookie available in the client?// 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));| string|\Cake\Http\Cookie\Cookie | $name | The name of the cookie to set, or a cookie object |
| array|string | $data | Either a string value, or an array of cookie options. |
withExpiredCookie(string|\Cake\Http\Cookie\CookieInterface $name, array $options = array()) : static
Create a new response with an expired cookie set.
path: Path the cookie applies todomain: Domain the cookie is for.secure: Is the cookie https?httpOnly: Is the cookie available in the client?// 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'));| string|\Cake\Http\Cookie\CookieInterface | $name | The name of the cookie to expire, or a cookie object |
| array | $options | An array of cookie options. |
getCookieCollection() : \Cake\Http\Cookie\CookieCollection
Get the CookieCollection from the response
cors(\Cake\Http\ServerRequest $request, string|array $allowedDomains = array(), string|array $allowedMethods = array(), string|array $allowedHeaders = array()) : \Cake\Http\CorsBuilder
Setup access for origin and methods on cross origin requests
This method allow multiple ways to setup the domains, see the examples
cors($request, 'https://www.cakephp.org');cors($request, 'https://*.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\Http\ServerRequest | $request | Request object |
| string|array | $allowedDomains | List of allowed domains, see method description for more details |
| string|array | $allowedMethods | List of HTTP verbs allowed |
| string|array | $allowedHeaders | List of HTTP headers allowed |
A builder object the provides a fluent interface for defining additional CORS headers.
file(string $path, array $options = array()) : void
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| string | $path | Path to file. If the path is not an absolute path that resolves
to a file, |
| array | $options | Options See above. |
withFile(string $path, array $options = array()) : static
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.
true sets download header and forces file to
be downloaded rather than displayed inline.| string | $path | Path to file. If the path is not an absolute path that resolves
to a file, |
| array | $options | Options See above. |
getFile() : \Cake\Filesystem\File|null
Get the current file if one exists.
The file to use in the response or null
stop(integer|string $status) : void
Stop execution of the current script. Wraps exit() making testing easier.
| integer|string | $status | See https://secure.php.net/exit for values |
_sendContent(string|callable $content) : void
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.
| string|callable | $content | String to send as response body or callable which returns/outputs content. |
convertCookieToArray(\Cake\Http\Cookie\CookieInterface $cookie) : array
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
| \Cake\Http\Cookie\CookieInterface | $cookie | Cookie object. |
validateFile(string $path) : \Cake\Filesystem\File
Validate a file path is a valid response body.
| string | $path | The path to the file. |
_fileRange(\Cake\Filesystem\File $file, string $httpRange) : void
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 | The file to set a range on. |
| string | $httpRange | The range to use. |
_sendFile(\Cake\Filesystem\File $file, array $range) : boolean
Reads out a file, and echos the content to the client.
| \Cake\Filesystem\File | $file | File object |
| array | $range | The range to read out of the file. |
True is whole file is echoed successfully or false if client connection is lost in between