HTTP_CONTINUE
HTTP_CONTINUE = 100
Response represents an HTTP response in JSON format.
Note that this class does not force the returned JSON content to be an object. It is however recommended that you do return an object as it protects yourself against XSSI and JSON-JavaScript Hijacking.
HTTP_RESPONSE_CACHE_CONTROL_DIRECTIVES = ['must_revalidate' => false, 'no_cache' => false, 'no_store' => false, 'no_transform' => false, 'public' => false, 'private' => false, 'proxy_revalidate' => false, 'max_age' => true, 's_maxage' => true, 'immutable' => false, 'last_modified' => true, 'etag' => true]
$headers : \Symfony\Component\HttpFoundation\ResponseHeaderBag
$statusTexts : array
Status codes translation table.
The list of codes is complete according to the {@link https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml} (last updated 2021-10-01).
Unless otherwise noted, the status code is defined in RFC2616.
$content : string
$version : string
$statusCode : int
$statusText : string
$charset : string
create(mixed $data = null, int $status = 200, array $headers = []) : static
Factory method for chainability.
Example:
return JsonResponse::create(['key' => 'value']) ->setSharedMaxAge(300);
| mixed | $data | The JSON response data |
| int | $status | The response status code |
| array | $headers | An array of response headers |
prepare(\Symfony\Component\HttpFoundation\Request $request) : $this
Prepares the Response before it is sent to the client.
This method tweaks the Response to ensure that it is compliant with RFC 2616. Most of the changes are based on the Request that is "associated" with this Response.
| \Symfony\Component\HttpFoundation\Request | $request |
setStatusCode(int $code, string $text = null) : $this
Sets the response status code.
If the status text is null it will be automatically populated for the known status codes and left empty otherwise.
| int | $code | |
| string | $text |
When the HTTP status code is not valid
isCacheable() : bool
Returns true if the response may safely be kept in a shared (surrogate) cache.
Responses marked "private" with an explicit Cache-Control directive are considered uncacheable.
Responses with neither a freshness lifetime (Expires, max-age) nor cache validator (Last-Modified, ETag) are considered uncacheable because there is no way to tell when or how to remove them from the cache.
Note that RFC 7231 and RFC 7234 possibly allow for a more permissive implementation, for example "status codes that are defined as cacheable by default [...] can be reused by a cache with heuristic expiration unless otherwise indicated" (https://tools.ietf.org/html/rfc7231#section-6.1)
isFresh() : bool
Returns true if the response is "fresh".
Fresh responses may be served from cache without any interaction with the origin. A response is considered fresh when it includes a Cache-Control/max-age indicator or Expires header and the calculated age is less than the freshness lifetime.
mustRevalidate() : bool
Returns true if the response must be revalidated by shared caches once it has become stale.
This method indicates that the response must not be served stale by a cache in any circumstance without first revalidating with the origin. When present, the TTL of the response should not be overridden to be greater than the value provided by the origin.
getMaxAge() : ?int
Returns the number of seconds after the time specified in the response's Date header when the response should no longer be considered fresh.
First, it checks for a s-maxage directive, then a max-age directive, and then it falls back on an expires header. It returns null when no maximum age can be established.
setCache(array $options) : $this
Sets the response's cache headers (validation and/or expiration).
Available options are: must_revalidate, no_cache, no_store, no_transform, public, private, proxy_revalidate, max_age, s_maxage, immutable, last_modified and etag.
| array | $options |
isNotModified(\Symfony\Component\HttpFoundation\Request $request) : bool
Determines if the Response validators (ETag, Last-Modified) match a conditional value specified in the Request.
If the Response is not modified, it sets the status code to 304 and removes the actual content by calling the setNotModified() method.
| \Symfony\Component\HttpFoundation\Request | $request |
fromJsonString(string $data, int $status = 200, array $headers = []) : static
Factory method for chainability.
Example:
return JsonResponse::fromJsonString('{"key": "value"}') ->setSharedMaxAge(300);
| string | $data | The JSON response string |
| int | $status | The response status code |
| array | $headers | An array of response headers |