class RedirectResponse extends Response
RedirectResponse represents an HTTP response doing a redirect.
Constants
HTTP_CONTINUE | |
HTTP_SWITCHING_PROTOCOLS | |
HTTP_PROCESSING | |
HTTP_OK | |
HTTP_CREATED | |
HTTP_ACCEPTED | |
HTTP_NON_AUTHORITATIVE_INFORMATION | |
HTTP_NO_CONTENT | |
HTTP_RESET_CONTENT | |
HTTP_PARTIAL_CONTENT | |
HTTP_MULTI_STATUS | |
HTTP_ALREADY_REPORTED | |
HTTP_IM_USED | |
HTTP_MULTIPLE_CHOICES | |
HTTP_MOVED_PERMANENTLY | |
HTTP_FOUND | |
HTTP_SEE_OTHER | |
HTTP_NOT_MODIFIED | |
HTTP_USE_PROXY | |
HTTP_RESERVED | |
HTTP_TEMPORARY_REDIRECT | |
HTTP_PERMANENTLY_REDIRECT | |
HTTP_BAD_REQUEST | |
HTTP_UNAUTHORIZED | |
HTTP_PAYMENT_REQUIRED | |
HTTP_FORBIDDEN | |
HTTP_NOT_FOUND | |
HTTP_METHOD_NOT_ALLOWED | |
HTTP_NOT_ACCEPTABLE | |
HTTP_PROXY_AUTHENTICATION_REQUIRED | |
HTTP_REQUEST_TIMEOUT | |
HTTP_CONFLICT | |
HTTP_GONE | |
HTTP_LENGTH_REQUIRED | |
HTTP_PRECONDITION_FAILED | |
HTTP_REQUEST_ENTITY_TOO_LARGE | |
HTTP_REQUEST_URI_TOO_LONG | |
HTTP_UNSUPPORTED_MEDIA_TYPE | |
HTTP_REQUESTED_RANGE_NOT_SATISFIABLE | |
HTTP_EXPECTATION_FAILED | |
HTTP_I_AM_A_TEAPOT | |
HTTP_MISDIRECTED_REQUEST | |
HTTP_UNPROCESSABLE_ENTITY | |
HTTP_LOCKED | |
HTTP_FAILED_DEPENDENCY | |
HTTP_RESERVED_FOR_WEBDAV_ADVANCED_COLLECTIONS_EXPIRED_PROPOSAL | |
HTTP_UPGRADE_REQUIRED | |
HTTP_PRECONDITION_REQUIRED | |
HTTP_TOO_MANY_REQUESTS | |
HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE | |
HTTP_UNAVAILABLE_FOR_LEGAL_REASONS | |
HTTP_INTERNAL_SERVER_ERROR | |
HTTP_NOT_IMPLEMENTED | |
HTTP_BAD_GATEWAY | |
HTTP_SERVICE_UNAVAILABLE | |
HTTP_GATEWAY_TIMEOUT | |
HTTP_VERSION_NOT_SUPPORTED | |
HTTP_VARIANT_ALSO_NEGOTIATES_EXPERIMENTAL | |
HTTP_INSUFFICIENT_STORAGE | |
HTTP_LOOP_DETECTED | |
HTTP_NOT_EXTENDED | |
HTTP_NETWORK_AUTHENTICATION_REQUIRED |
Properties
ResponseHeaderBag | $headers | from Response | |
static array | $statusTexts | Status codes translation table. | from Response |
Methods
__construct(string $url, int $status = 302, array $headers = array()) Creates a redirect response so that it conforms to the rules defined for a redirect status code. | ||
static Response | create($url = '', int $status = 302, array $headers = array()) Factory method for chainability. | |
string | __toString() Returns the Response as an HTTP string. | from Response |
__clone() Clones the current Response instance. | from Response | |
Response | prepare(Request $request) Prepares the Response before it is sent to the client. | from Response |
Response | sendHeaders() Sends HTTP headers. | from Response |
Response | sendContent() Sends content for the current web response. | from Response |
Response | send() Sends HTTP headers and content. | from Response |
Response | setContent(mixed $content) Sets the response content. | from Response |
string | getContent() Gets the current response content. | from Response |
Response | setProtocolVersion(string $version) Sets the HTTP protocol version (1.0 or 1.1). | from Response |
string | getProtocolVersion() Gets the HTTP protocol version. | from Response |
Response | setStatusCode(int $code, mixed $text = null) Sets the response status code. | from Response |
int | getStatusCode() Retrieves the status code for the current web response. | from Response |
Response | setCharset(string $charset) Sets the response charset. | from Response |
string | getCharset() Retrieves the response charset. | from Response |
bool | isCacheable() Returns true if the response is worth caching under any circumstance. | from Response |
bool | isFresh() Returns true if the response is "fresh". | from Response |
bool | isValidateable() Returns true if the response includes headers that can be used to validate the response with the origin server using a conditional GET request. | from Response |
Response | setPrivate() Marks the response as "private". | from Response |
Response | setPublic() Marks the response as "public". | from Response |
bool | mustRevalidate() Returns true if the response must be revalidated by caches. | from Response |
DateTime | getDate() Returns the Date header as a DateTime instance. | from Response |
Response | setDate(DateTime $date) Sets the Date header. | from Response |
int | getAge() Returns the age of the response. | from Response |
Response | expire() Marks the response stale by setting the Age header to be equal to the maximum age of the response. | from Response |
DateTime|null | getExpires() Returns the value of the Expires header as a DateTime instance. | from Response |
Response | setExpires(DateTime $date = null) Sets the Expires HTTP header with a DateTime instance. | from Response |
int|null | getMaxAge() Returns the number of seconds after the time specified in the response's Date header when the response should no longer be considered fresh. | from Response |
Response | setMaxAge(int $value) Sets the number of seconds after which the response should no longer be considered fresh. | from Response |
Response | setSharedMaxAge(int $value) Sets the number of seconds after which the response should no longer be considered fresh by shared caches. | from Response |
int|null | getTtl() Returns the response's time-to-live in seconds. | from Response |
Response | setTtl(int $seconds) Sets the response's time-to-live for shared caches. | from Response |
Response | setClientTtl(int $seconds) Sets the response's time-to-live for private/client caches. | from Response |
DateTime|null | getLastModified() Returns the Last-Modified HTTP header as a DateTime instance. | from Response |
Response | setLastModified(DateTime $date = null) Sets the Last-Modified HTTP header with a DateTime instance. | from Response |
string|null | getEtag() Returns the literal value of the ETag HTTP header. | from Response |
Response | setEtag(string|null $etag = null, bool $weak = false) Sets the ETag value. | from Response |
Response | setCache(array $options) Sets the response's cache headers (validation and/or expiration). | from Response |
Response | setNotModified() Modifies the response so that it conforms to the rules defined for a 304 status code. | from Response |
bool | hasVary() Returns true if the response includes a Vary header. | from Response |
array | getVary() Returns an array of header names given in the Vary header. | from Response |
Response | setVary(string|array $headers, bool $replace = true) Sets the Vary header. | from Response |
bool | isNotModified(Request $request) Determines if the Response validators (ETag, Last-Modified) match a conditional value specified in the Request. | from Response |
bool | isInvalid() Is response invalid? | from Response |
bool | isInformational() Is response informative? | from Response |
bool | isSuccessful() Is response successful? | from Response |
bool | isRedirection() Is the response a redirect? | from Response |
bool | isClientError() Is there a client error? | from Response |
bool | isServerError() Was there a server side error? | from Response |
bool | isOk() Is the response OK? | from Response |
bool | isForbidden() Is the response forbidden? | from Response |
bool | isNotFound() Is the response a not found error? | from Response |
bool | isRedirect(string $location = null) Is the response a redirect of some form? | from Response |
bool | isEmpty() Is the response empty? | from Response |
static | closeOutputBuffers(int $targetLevel, bool $flush) Cleans or flushes output buffers up to target level. | from Response |
string | getTargetUrl() Returns the target URL. | |
RedirectResponse | setTargetUrl(string $url) Sets the redirect target of this response. |
Details
__construct(string $url, int $status = 302, array $headers = array())
Creates a redirect response so that it conforms to the rules defined for a redirect status code.
static Response create($url = '', int $status = 302, array $headers = array())
Factory method for chainability.
Example:
return Response::create($body, 200)
->setSharedMaxAge(300);
string __toString()
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.
__clone()
Clones the current Response instance.
Response prepare(Request $request)
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.
Response sendHeaders()
Sends HTTP headers.
Response sendContent()
Sends content for the current web response.
Response send()
Sends HTTP headers and content.
Response setContent(mixed $content)
Sets the response content.
Valid types are strings, numbers, null, and objects that implement a __toString() method.
string getContent()
Gets the current response content.
Response setProtocolVersion(string $version)
Sets the HTTP protocol version (1.0 or 1.1).
string getProtocolVersion()
Gets the HTTP protocol version.
Response setStatusCode(int $code, mixed $text = null)
Sets the response status code.
int getStatusCode()
Retrieves the status code for the current web response.
Response setCharset(string $charset)
Sets the response charset.
string getCharset()
Retrieves the response charset.
bool isCacheable()
Returns true if the response is worth caching under any circumstance.
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.
bool isFresh()
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.
bool isValidateable()
Returns true if the response includes headers that can be used to validate the response with the origin server using a conditional GET request.
Response setPrivate()
Marks the response as "private".
It makes the response ineligible for serving other clients.
Response setPublic()
Marks the response as "public".
It makes the response eligible for serving other clients.
bool mustRevalidate()
Returns true if the response must be revalidated by caches.
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.
DateTime getDate()
Returns the Date header as a DateTime instance.
int getAge()
Returns the age of the response.
Response expire()
Marks the response stale by setting the Age header to be equal to the maximum age of the response.
DateTime|null getExpires()
Returns the value of the Expires header as a DateTime instance.
Response setExpires(DateTime $date = null)
Sets the Expires HTTP header with a DateTime instance.
Passing null as value will remove the header.
int|null getMaxAge()
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.
Response setMaxAge(int $value)
Sets the number of seconds after which the response should no longer be considered fresh.
This methods sets the Cache-Control max-age directive.
Response setSharedMaxAge(int $value)
Sets the number of seconds after which the response should no longer be considered fresh by shared caches.
This methods sets the Cache-Control s-maxage directive.
int|null getTtl()
Returns the response's time-to-live in seconds.
It returns null when no freshness information is present in the response.
When the responses TTL is <= 0, the response may not be served from cache without first revalidating with the origin.
Response setTtl(int $seconds)
Sets the response's time-to-live for shared caches.
This method adjusts the Cache-Control/s-maxage directive.
Response setClientTtl(int $seconds)
Sets the response's time-to-live for private/client caches.
This method adjusts the Cache-Control/max-age directive.
DateTime|null getLastModified()
Returns the Last-Modified HTTP header as a DateTime instance.
Response setLastModified(DateTime $date = null)
Sets the Last-Modified HTTP header with a DateTime instance.
Passing null as value will remove the header.
string|null getEtag()
Returns the literal value of the ETag HTTP header.
Response setEtag(string|null $etag = null, bool $weak = false)
Sets the ETag value.
Response setCache(array $options)
Sets the response's cache headers (validation and/or expiration).
Available options are: etag, lastmodified, maxage, s_maxage, private, and public.
Response setNotModified()
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.
bool hasVary()
Returns true if the response includes a Vary header.
array getVary()
Returns an array of header names given in the Vary header.
Response setVary(string|array $headers, bool $replace = true)
Sets the Vary header.
bool isNotModified(Request $request)
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.
bool isInvalid()
Is response invalid?
bool isInformational()
Is response informative?
bool isSuccessful()
Is response successful?
bool isRedirection()
Is the response a redirect?
bool isClientError()
Is there a client error?
bool isServerError()
Was there a server side error?
bool isOk()
Is the response OK?
bool isForbidden()
Is the response forbidden?
bool isNotFound()
Is the response a not found error?
bool isRedirect(string $location = null)
Is the response a redirect of some form?
bool isEmpty()
Is the response empty?
static closeOutputBuffers(int $targetLevel, bool $flush)
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.
string getTargetUrl()
Returns the target URL.
RedirectResponse setTargetUrl(string $url)
Sets the redirect target of this response.
Please login to continue.