Class Symfony\Component\HttpFoundation\Response

Response represents an HTTP response.

Symfony\Component\HttpFoundation\Response
- Symfony\Component\HttpFoundation\RedirectResponse
  - Illuminate\Http\RedirectResponse uses ForwardsCalls, ResponseTrait, Macroable
- Symfony\Component\HttpFoundation\JsonResponse
  - Illuminate\Http\JsonResponse uses ResponseTrait, Macroable

Methods


					
	public

__construct(?string $content = '', int $status = 200, array $headers = [])

Parameters

$status

The HTTP status code (200 "OK" by default)

Throws

InvalidArgumentException

When the HTTP status code is not valid

Overriden by


					
	public

__toString(): string

Returns the Response as an HTTP string.

The string representation of the Response is the same as the one that will be sent to the client only if the prepare() method has been called before.


					
	public

__clone()

Clones the current Response instance.


					
	public

prepare(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.


					
	public

sendHeaders(positive-int|null $statusCode = null): $this

Sends HTTP headers.

Parameters

$statusCode

The status code to use, override the statusCode property if set and not null


					
	public

sendContent(): $this

Sends content for the current web response.


					
	public

send(bool $flush = true): $this

Sends HTTP headers and content.

Parameters

$flush

Whether output buffers should be flushed


					
	public

setContent(?string $content): $this

Sets the response content.


					
	public

getContent(): string|false

Gets the current response content.


					
	public

setProtocolVersion(string $version): $this

Sets the HTTP protocol version (1.0 or 1.1).


					
	public

getProtocolVersion(): string

Gets the HTTP protocol version.


					
	public

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.

Throws

InvalidArgumentException

When the HTTP status code is not valid


					
	public

getStatusCode(): int

Retrieves the status code for the current web response.


					
	public

setCharset(string $charset): $this

Sets the response charset.


					
	public

getCharset(): ?string

Retrieves the response charset.


					
	public

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)


					
	public

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.


					
	public

isValidateable(): bool

Returns true if the response includes headers that can be used to validate the response with the origin server using a…

Returns true if the response includes headers that can be used to validate the response with the origin server using a conditional GET request.


					
	public

setPrivate(): $this

Marks the response as "private".

It makes the response ineligible for serving other clients.


					
	public

setPublic(): $this

Marks the response as "public".

It makes the response eligible for serving other clients.


					
	public

setImmutable(bool $immutable = true): $this

Marks the response as "immutable".


					
	public

isImmutable(): bool

Returns true if the response is marked as "immutable".


					
	public

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.


					
	public

getDate(): ?DateTimeImmutable

Returns the Date header as a DateTime instance.

Throws

RuntimeException

When the header is not parseable


					
	public

setDate(DateTimeInterface $date): $this

Sets the Date header.


					
	public

getAge(): int

Returns the age of the response in seconds.


					
	public

expire(): $this

Marks the response stale by setting the Age header to be equal to the maximum age of the response.


					
	public

getExpires(): ?DateTimeImmutable

Returns the value of the Expires header as a DateTime instance.


					
	public

setExpires(?DateTimeInterface $date): $this

Sets the Expires HTTP header with a DateTime instance.

Passing null as value will remove the header.


					
	public

getMaxAge(): ?int

Returns the number of seconds after the time specified in the response's Date header when the response should no longer…

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.


					
	public

setMaxAge(int $value): $this

Sets the number of seconds after which the response should no longer be considered fresh.

This method sets the Cache-Control max-age directive.


					
	public

setStaleIfError(int $value): $this

Sets the number of seconds after which the response should no longer be returned by shared caches when backend is down.

This method sets the Cache-Control stale-if-error directive.


					
	public

setStaleWhileRevalidate(int $value): $this

Sets the number of seconds after which the response should no longer return stale content by shared caches.

This method sets the Cache-Control stale-while-revalidate directive.


					
	public

setSharedMaxAge(int $value): $this

Sets the number of seconds after which the response should no longer be considered fresh by shared caches.

This method sets the Cache-Control s-maxage directive.


					
	public

getTtl(): ?int

Returns the response's time-to-live in seconds.

It returns null when no freshness information is present in the response.

When the response's TTL is 0, the response may not be served from cache without first revalidating with the origin.


					
	public

setTtl(int $seconds): $this

Sets the response's time-to-live for shared caches in seconds.

This method adjusts the Cache-Control/s-maxage directive.


					
	public

setClientTtl(int $seconds): $this

Sets the response's time-to-live for private/client caches in seconds.

This method adjusts the Cache-Control/max-age directive.


					
	public

getLastModified(): ?DateTimeImmutable

Returns the Last-Modified HTTP header as a DateTime instance.

Throws

RuntimeException

When the HTTP header is not parseable


					
	public

setLastModified(?DateTimeInterface $date): $this

Sets the Last-Modified HTTP header with a DateTime instance.

Passing null as value will remove the header.


					
	public

getEtag(): ?string

Returns the literal value of the ETag HTTP header.


					
	public

setEtag(string|null $etag, bool $weak = false): $this

Sets the ETag value.

Parameters

`$etag`	The ETag unique identifier or null to remove the header
`$weak`	Whether you want a weak ETag or not


					
	public

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.

Throws

InvalidArgumentException


					
	public

setNotModified(): $this

Modifies the response so that it conforms to the rules defined for a 304 status code.

This sets the status, removes the body, and discards any headers that MUST NOT be included in 304 responses.


					
	public

hasVary(): bool

Returns true if the response includes a Vary header.


					
	public

getVary(): array

Returns an array of header names given in the Vary header.


					
	public

setVary(string|array $headers, bool $replace = true): $this

Sets the Vary header.

Parameters

$replace

Whether to replace the actual value or not (true by default)


					
	public

isNotModified(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.


					
	public

isInvalid(): bool

Is response invalid?


					
	public

isInformational(): bool

Is response informative?


					
	public

isSuccessful(): bool

Is response successful?


					
	public

isRedirection(): bool

Is the response a redirect?


					
	public

isClientError(): bool

Is there a client error?


					
	public

isServerError(): bool

Was there a server side error?


					
	public

isOk(): bool

Is the response OK?


					
	public

isForbidden(): bool

Is the response forbidden?


					
	public

isNotFound(): bool

Is the response a not found error?


					
	public

isRedirect(?string $location = null): bool

Is the response a redirect of some form?


					
	public

isEmpty(): bool

Is the response empty?


					
	public
					static

closeOutputBuffers(int $targetLevel, bool $flush): void

Cleans or flushes output buffers up to target level.

Resulting level can be greater than target level if a non-removable buffer has been encountered.


					
	public

setContentSafe(bool $safe = true): void

Marks a response as safe according to RFC8674.


					
	protected

ensureIEOverSSLCompatibility(Request $request): void

Checks if we need to remove Cache-Control for SSL encrypted downloads when using IE < 9.

Constants
`public`	`HTTP_CONTINUE = 100`	#
`public`	`HTTP_SWITCHING_PROTOCOLS = 101`	#
`public`	`HTTP_PROCESSING = 102`	#
`public`	`HTTP_EARLY_HINTS = 103`	#
`public`	`HTTP_OK = 200`	#
`public`	`HTTP_CREATED = 201`	#
`public`	`HTTP_ACCEPTED = 202`	#
`public`	`HTTP_NON_AUTHORITATIVE_INFORMATION = 203`	#
`public`	`HTTP_NO_CONTENT = 204`	#
`public`	`HTTP_RESET_CONTENT = 205`	#
`public`	`HTTP_PARTIAL_CONTENT = 206`	#
`public`	`HTTP_MULTI_STATUS = 207`	#
`public`	`HTTP_ALREADY_REPORTED = 208`	#
`public`	`HTTP_IM_USED = 226`	#
`public`	`HTTP_MULTIPLE_CHOICES = 300`	#
`public`	`HTTP_MOVED_PERMANENTLY = 301`	#
`public`	`HTTP_FOUND = 302`	#
`public`	`HTTP_SEE_OTHER = 303`	#
`public`	`HTTP_NOT_MODIFIED = 304`	#
`public`	`HTTP_USE_PROXY = 305`	#
`public`	`HTTP_RESERVED = 306`	#
`public`	`HTTP_TEMPORARY_REDIRECT = 307`	#
`public`	`HTTP_PERMANENTLY_REDIRECT = 308`	#
`public`	`HTTP_BAD_REQUEST = 400`	#
`public`	`HTTP_UNAUTHORIZED = 401`	#
`public`	`HTTP_PAYMENT_REQUIRED = 402`	#
`public`	`HTTP_FORBIDDEN = 403`	#
`public`	`HTTP_NOT_FOUND = 404`	#
`public`	`HTTP_METHOD_NOT_ALLOWED = 405`	#
`public`	`HTTP_NOT_ACCEPTABLE = 406`	#
`public`	`HTTP_PROXY_AUTHENTICATION_REQUIRED = 407`	#
`public`	`HTTP_REQUEST_TIMEOUT = 408`	#
`public`	`HTTP_CONFLICT = 409`	#
`public`	`HTTP_GONE = 410`	#
`public`	`HTTP_LENGTH_REQUIRED = 411`	#
`public`	`HTTP_PRECONDITION_FAILED = 412`	#
`public`	`HTTP_REQUEST_ENTITY_TOO_LARGE = 413`	#
`public`	`HTTP_REQUEST_URI_TOO_LONG = 414`	#
`public`	`HTTP_UNSUPPORTED_MEDIA_TYPE = 415`	#
`public`	`HTTP_REQUESTED_RANGE_NOT_SATISFIABLE = 416`	#
`public`	`HTTP_EXPECTATION_FAILED = 417`	#
`public`	`HTTP_I_AM_A_TEAPOT = 418`	#
`public`	`HTTP_MISDIRECTED_REQUEST = 421`	#
`public`	`HTTP_UNPROCESSABLE_ENTITY = 422`	#
`public`	`HTTP_LOCKED = 423`	#
`public`	`HTTP_FAILED_DEPENDENCY = 424`	#
`public`	`HTTP_TOO_EARLY = 425`	#
`public`	`HTTP_UPGRADE_REQUIRED = 426`	#
`public`	`HTTP_PRECONDITION_REQUIRED = 428`	#
`public`	`HTTP_TOO_MANY_REQUESTS = 429`	#
`public`	`HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE = 431`	#
`public`	`HTTP_UNAVAILABLE_FOR_LEGAL_REASONS = 451`	#
`public`	`HTTP_INTERNAL_SERVER_ERROR = 500`	#
`public`	`HTTP_NOT_IMPLEMENTED = 501`	#
`public`	`HTTP_BAD_GATEWAY = 502`	#
`public`	`HTTP_SERVICE_UNAVAILABLE = 503`	#
`public`	`HTTP_GATEWAY_TIMEOUT = 504`	#
`public`	`HTTP_VERSION_NOT_SUPPORTED = 505`	#
`public`	`HTTP_VARIANT_ALSO_NEGOTIATES_EXPERIMENTAL = 506`	#
`public`	`HTTP_INSUFFICIENT_STORAGE = 507`	#
`public`	`HTTP_LOOP_DETECTED = 508`	#
`public`	`HTTP_NOT_EXTENDED = 510`	#
`public`	`HTTP_NETWORK_AUTHENTICATION_REQUIRED = 511`	#

Properties
`public`	`ResponseHeaderBag`	`$headers`	#
`protected`	`string`	`$content`	#
`protected`	`string`	`$version`	#
`protected`	`int`	`$statusCode`	#
`protected`	`string`	`$statusText`	#
`protected`	`?string`	`$charset = null`	#
`public static`	`array`	$statusTexts = [ 100 => 'Continue', 101 => 'Switching Protocols', 102 => 'Processing', 103 => 'Early Hints', 200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content', 207 => 'Multi-Status', 208 => 'Already Reported', 226 => 'IM Used', 300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 307 => 'Temporary Redirect', 308 => 'Permanent Redirect', 400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Timeout', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Content Too Large', 414 => 'URI Too Long', 415 => 'Unsupported Media Type', 416 => 'Range Not Satisfiable', 417 => 'Expectation Failed', 418 => 'I\'m a teapot', 421 => 'Misdirected Request', 422 => 'Unprocessable Content', 423 => 'Locked', 424 => 'Failed Dependency', 425 => 'Too Early', 426 => 'Upgrade Required', 428 => 'Precondition Required', 429 => 'Too Many Requests', 431 => 'Request Header Fields Too Large', 451 => 'Unavailable For Legal Reasons', 500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Timeout', 505 => 'HTTP Version Not Supported', 506 => 'Variant Also Negotiates', 507 => 'Insufficient Storage', 508 => 'Loop Detected', 510 => 'Not Extended', 511 => 'Network Authentication Required', ] Status codes translation table. 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 Hypertext Transfer Protocol (HTTP) Status Code Registry} (last updated 2021-10-01). Unless otherwise noted, the status code is defined in RFC2616.	#

Namespaces

Classes

Class Symfony\Component\HttpFoundation\Response

Parameters

Throws

Overriden by

Parameters

Parameters

Throws

Throws

Throws

Parameters

Throws

Parameters