class RedirectResponse extends Response
RedirectResponse represents an HTTP response doing a redirect.
Properties
| ResponseHeaderBag | $headers | |
| static | $statusTexts |
Methods
|
__construct(string $url, integer $status = 302)
Constructor. |
||
| string |
__toString()
Returns the response content as it will be sent (with the headers). |
from Response |
|
__clone()
Clones the current Response instance. |
from Response | |
|
prepare()
Prepares the Response before it is sent to the client. |
from Response | |
|
sendHeaders()
Sends HTTP headers. |
from Response | |
|
sendContent()
Sends content for the current web response. |
from Response | |
|
send()
Sends HTTP headers and content. |
from Response | |
|
setContent(mixed $content)
Sets the response content. |
from Response | |
| string |
getContent()
Gets the current response content. |
from 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 |
|
setStatusCode(integer $code, string $text = null)
Sets the response status code. |
from Response | |
| string |
getStatusCode()
Retrieves the status code for the current web response. |
from Response |
|
setCharset(string $charset)
Sets the response charset. |
from Response | |
| string |
getCharset()
Retrieves the response charset. |
from Response |
| Boolean |
isCacheable()
Returns true if the response is worth caching under any circumstance. |
from Response |
| Boolean |
isFresh()
Returns true if the response is "fresh". |
from Response |
| Boolean |
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 |
|
setPrivate()
Marks the response as "private". |
from Response | |
|
setPublic()
Marks the response as "public". |
from Response | |
| Boolean |
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 |
|
setDate(DateTime $date)
Sets the Date header. |
from Response | |
| integer |
getAge()
Returns the age of the response. |
from Response |
|
expire()
Marks the response stale by setting the Age header to be equal to the maximum age of the response. |
from Response | |
| DateTime |
getExpires()
Returns the value of the Expires header as a DateTime instance. |
from Response |
|
setExpires(DateTime $date = null)
Sets the Expires HTTP header with a DateTime instance. |
from Response | |
| integer|null |
getMaxAge()
Sets the number of seconds after the time specified in the response's Date header when the the response should no longer be considered fresh. |
from Response |
|
setMaxAge(integer $value)
Sets the number of seconds after which the response should no longer be considered fresh. |
from Response | |
|
setSharedMaxAge(integer $value)
Sets the number of seconds after which the response should no longer be considered fresh by shared caches. |
from Response | |
| integer |
getTtl()
Returns the response's time-to-live in seconds. |
from Response |
|
setTtl(integer $seconds)
Sets the response's time-to-live for shared caches. |
from Response | |
|
setClientTtl(integer $seconds)
Sets the response's time-to-live for private/client caches. |
from Response | |
| DateTime |
getLastModified()
Returns the Last-Modified HTTP header as a DateTime instance. |
from Response |
|
setLastModified(DateTime $date = null)
Sets the Last-Modified HTTP header with a DateTime instance. |
from Response | |
| string |
getEtag()
Returns the literal value of the ETag HTTP header. |
from Response |
|
setEtag(string $etag = null, Boolean $weak = false)
Sets the ETag value. |
from Response | |
|
setCache(array $options)
Sets the response's cache headers (validation and/or expiration). |
from Response | |
|
setNotModified()
Modifies the response so that it conforms to the rules defined for a 304 status code. |
from Response | |
| Boolean |
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 |
|
setVary(string|array $headers, Boolean $replace = true)
Sets the Vary header. |
from Response | |
| Boolean |
isNotModified(Request $request)
Determines if the Response validators (ETag, Last-Modified) match a conditional value specified in the Request. |
from Response |
| Boolean | isInvalid() | from Response |
| Boolean | isInformational() | from Response |
| Boolean | isSuccessful() | from Response |
| Boolean | isRedirection() | from Response |
| Boolean | isClientError() | from Response |
| Boolean | isServerError() | from Response |
| Boolean | isOk() | from Response |
| Boolean | isForbidden() | from Response |
| Boolean | isNotFound() | from Response |
| Boolean | isRedirect(string $location = null) | from Response |
| Boolean | isEmpty() | from Response |
Details
at line 33
public
__construct(string $url, integer $status = 302)
Constructor.
in Response at line 103
public string
__toString()
Returns the response content as it will be sent (with the headers).
in Response at line 116
public
__clone()
Clones the current Response instance.
in Response at line 127
public
prepare()
Prepares the Response before it is sent to the client.
This method tweaks the Response to ensure that it is
compliant with RFC 2616.
in Response at line 151
public
sendHeaders()
Sends HTTP headers.
in Response at line 179
public
sendContent()
Sends content for the current web response.
in Response at line 189
public
send()
Sends HTTP headers and content.
in Response at line 208
public
setContent(mixed $content)
Sets the response content.
Valid types are strings, numbers, and objects that implement a __toString() method.
in Response at line 224
public string
getContent()
Gets the current response content.
in Response at line 236
public
setProtocolVersion(string $version)
Sets the HTTP protocol version (1.0 or 1.1).
in Response at line 248
public string
getProtocolVersion()
Gets the HTTP protocol version.
in Response at line 263
public
setStatusCode(integer $code, string $text = null)
Sets the response status code.
in Response at line 280
public string
getStatusCode()
Retrieves the status code for the current web response.
in Response at line 292
public
setCharset(string $charset)
Sets the response charset.
in Response at line 304
public string
getCharset()
Retrieves the response charset.
in Response at line 322
public Boolean
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.
in Response at line 346
public Boolean
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 Expiration header and the calculated age is less than the freshness lifetime.
in Response at line 359
public Boolean
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.
in Response at line 371
public
setPrivate()
Marks the response as "private".
It makes the response ineligible for serving other clients.
in Response at line 384
public
setPublic()
Marks the response as "public".
It makes the response eligible for serving other clients.
in Response at line 402
public Boolean
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.
in Response at line 416
public DateTime
getDate()
Returns the Date header as a DateTime instance.
in Response at line 428
public
setDate(DateTime $date)
Sets the Date header.
in Response at line 439
public integer
getAge()
Returns the age of the response.
in Response at line 453
public
expire()
Marks the response stale by setting the Age header to be equal to the maximum age of the response.
in Response at line 467
public DateTime
getExpires()
Returns the value of the Expires header as a DateTime instance.
in Response at line 481
public
setExpires(DateTime $date = null)
Sets the Expires HTTP header with a DateTime instance.
If passed a null value, it removes the header.
in Response at line 503
public integer|null
getMaxAge()
Sets the number of seconds after the time specified in the response's Date header when the 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.
in Response at line 529
public
setMaxAge(integer $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.
in Response at line 543
public
setSharedMaxAge(integer $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.
in Response at line 561
public integer
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.
in Response at line 579
public
setTtl(integer $seconds)
Sets the response's time-to-live for shared caches.
This method adjusts the Cache-Control/s-maxage directive.
in Response at line 593
public
setClientTtl(integer $seconds)
Sets the response's time-to-live for private/client caches.
This method adjusts the Cache-Control/max-age directive.
in Response at line 605
public DateTime
getLastModified()
Returns the Last-Modified HTTP header as a DateTime instance.
in Response at line 619
public
setLastModified(DateTime $date = null)
Sets the Last-Modified HTTP header with a DateTime instance.
If passed a null value, it removes the header.
in Response at line 637
public string
getEtag()
Returns the literal value of the ETag HTTP header.
in Response at line 650
public
setEtag(string $etag = null, Boolean $weak = false)
Sets the ETag value.
in Response at line 672
public
setCache(array $options)
Sets the response's cache headers (validation and/or expiration).
Available options are: etag, last_modified, max_age, s_maxage, private, and public.
in Response at line 721
public
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.
in Response at line 739
public Boolean
hasVary()
Returns true if the response includes a Vary header.
in Response at line 751
public array
getVary()
Returns an array of header names given in the Vary header.
in Response at line 768
public
setVary(string|array $headers, Boolean $replace = true)
Sets the Vary header.
in Response at line 786
public Boolean
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.