class TrustedRedirectResponse in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/lib/Drupal/Core/Routing/TrustedRedirectResponse.php \Drupal\Core\Routing\TrustedRedirectResponse
Provides a redirect response which contains trusted URLs.
Use this class in case you know that you want to redirect to an external URL.
Hierarchy
- class \Symfony\Component\HttpFoundation\Response
- class \Symfony\Component\HttpFoundation\RedirectResponse
- class \Drupal\Component\HttpFoundation\SecuredRedirectResponse
- class \Drupal\Core\Routing\CacheableSecuredRedirectResponse implements CacheableResponseInterface uses CacheableResponseTrait
- class \Drupal\Core\Routing\TrustedRedirectResponse uses LocalAwareRedirectResponseTrait
- class \Drupal\Core\Routing\CacheableSecuredRedirectResponse implements CacheableResponseInterface uses CacheableResponseTrait
- class \Drupal\Component\HttpFoundation\SecuredRedirectResponse
- class \Symfony\Component\HttpFoundation\RedirectResponse
Expanded class hierarchy of TrustedRedirectResponse
2 files declare their use of TrustedRedirectResponse
- RedirectResponseSubscriberTest.php in core/
tests/ Drupal/ Tests/ Core/ EventSubscriber/ RedirectResponseSubscriberTest.php - Contains \Drupal\Tests\Core\EventSubscriber\RedirectResponseSubscriberTest.
- TrustedRedirectResponseTest.php in core/
tests/ Drupal/ Tests/ Core/ Routing/ TrustedRedirectResponseTest.php - Contains \Drupal\Tests\Core\Routing\TrustedRedirectResponseTest.
File
- core/
lib/ Drupal/ Core/ Routing/ TrustedRedirectResponse.php, line 15 - Contains \Drupal\Core\Routing\TrustedRedirectResponse.
Namespace
Drupal\Core\RoutingView source
class TrustedRedirectResponse extends CacheableSecuredRedirectResponse {
use LocalAwareRedirectResponseTrait;
/**
* A list of trusted URLs, which are safe to redirect to.
*
* @var string[]
*/
protected $trustedUrls = array();
/**
* {@inheritdoc}
*/
public function __construct($url, $status = 302, $headers = array()) {
$this->trustedUrls[$url] = TRUE;
parent::__construct($url, $status, $headers);
}
/**
* Sets the target URL to a trusted URL.
*
* @param string $url
* A trusted URL.
*
* @return $this
*/
public function setTrustedTargetUrl($url) {
$this->trustedUrls[$url] = TRUE;
return $this
->setTargetUrl($url);
}
/**
* {@inheritdoc}
*/
protected function isSafe($url) {
return !empty($this->trustedUrls[$url]) || $this
->isLocal($url);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CacheableResponseTrait:: |
protected | property | The cacheability metadata. | |
CacheableResponseTrait:: |
public | function | ||
CacheableResponseTrait:: |
public | function | ||
CacheableSecuredRedirectResponse:: |
protected | function |
Copies over the values from the given response. Overrides SecuredRedirectResponse:: |
|
LocalAwareRedirectResponseTrait:: |
protected | property | The request context. | |
LocalAwareRedirectResponseTrait:: |
protected | function | Returns the request context. | |
LocalAwareRedirectResponseTrait:: |
protected | function | ||
LocalAwareRedirectResponseTrait:: |
public | function | Sets the request context. | |
RedirectResponse:: |
protected | property | ||
RedirectResponse:: |
public static | function |
Factory method for chainability. Overrides Response:: |
|
RedirectResponse:: |
public | function | Returns the target URL. | |
Response:: |
protected | property | ||
Response:: |
protected | property | ||
Response:: |
public | property | ||
Response:: |
protected | property | ||
Response:: |
protected | property | ||
Response:: |
public static | property | Status codes translation table. | |
Response:: |
protected | property | ||
Response:: |
public static | function | Cleans or flushes output buffers up to target level. | |
Response:: |
protected | function | Checks if we need to remove Cache-Control for SSL encrypted downloads when using IE < 9. | |
Response:: |
public | function | Marks the response stale by setting the Age header to be equal to the maximum age of the response. | |
Response:: |
public | function | Returns the age of the response. | |
Response:: |
public | function | Retrieves the response charset. | |
Response:: |
public | function | Gets the current response content. | 2 |
Response:: |
public | function | Returns the Date header as a DateTime instance. | |
Response:: |
public | function | Returns the literal value of the ETag HTTP header. | |
Response:: |
public | function | Returns the value of the Expires header as a DateTime instance. | |
Response:: |
public | function | Returns the Last-Modified HTTP header as a DateTime instance. | |
Response:: |
public | function | Returns the number of seconds after the time specified in the response's Date header when the response should no longer be considered fresh. | |
Response:: |
public | function | Gets the HTTP protocol version. | |
Response:: |
public | function | Retrieves the status code for the current web response. | |
Response:: |
public | function | Returns the response's time-to-live in seconds. | |
Response:: |
public | function | Returns an array of header names given in the Vary header. | |
Response:: |
public | function | Returns true if the response includes a Vary header. | |
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
constant | |||
Response:: |
public | function | Returns true if the response is worth caching under any circumstance. | |
Response:: |
public | function | Is there a client error? | |
Response:: |
public | function | Is the response empty? | |
Response:: |
public | function | Is the response forbidden? | |
Response:: |
public | function | Returns true if the response is "fresh". | |
Response:: |
public | function | Is response informative? | |
Response:: |
public | function | Is response invalid? | |
Response:: |
public | function | Is the response a not found error? | |
Response:: |
public | function | Determines if the Response validators (ETag, Last-Modified) match a conditional value specified in the Request. | |
Response:: |
public | function | Is the response OK? | |
Response:: |
public | function | Is the response a redirect of some form? | |
Response:: |
public | function | Is the response a redirect? | |
Response:: |
public | function | Was there a server side error? | |
Response:: |
public | function | Is response successful? | |
Response:: |
public | function | 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:: |
public | function | Returns true if the response must be revalidated by caches. | |
Response:: |
public | function | Prepares the Response before it is sent to the client. | 1 |
Response:: |
public | function | Sends HTTP headers and content. | |
Response:: |
public | function | Sends content for the current web response. | 2 |
Response:: |
public | function | Sends HTTP headers. | |
Response:: |
public | function | Sets the response's cache headers (validation and/or expiration). | |
Response:: |
public | function | Sets the response charset. | |
Response:: |
public | function | Sets the response's time-to-live for private/client caches. | |
Response:: |
public | function | Sets the response content. | 3 |
Response:: |
public | function | Sets the Date header. | |
Response:: |
public | function | Sets the ETag value. | |
Response:: |
public | function | Sets the Expires HTTP header with a DateTime instance. | |
Response:: |
public | function | Sets the Last-Modified HTTP header with a DateTime instance. | |
Response:: |
public | function | Sets the number of seconds after which the response should no longer be considered fresh. | |
Response:: |
public | function | Modifies the response so that it conforms to the rules defined for a 304 status code. | |
Response:: |
public | function | Marks the response as "private". | |
Response:: |
public | function | Sets the HTTP protocol version (1.0 or 1.1). | |
Response:: |
public | function | Marks the response as "public". | |
Response:: |
public | function | Sets the number of seconds after which the response should no longer be considered fresh by shared caches. | |
Response:: |
public | function | Sets the response status code. | |
Response:: |
public | function | Sets the response's time-to-live for shared caches. | |
Response:: |
public | function | Sets the Vary header. | |
Response:: |
public | function | Clones the current Response instance. | |
Response:: |
public | function | Returns the Response as an HTTP string. | |
SecuredRedirectResponse:: |
public static | function | Copies an existing redirect response into a safe one. | |
SecuredRedirectResponse:: |
public | function |
Sets the redirect target of this response. Overrides RedirectResponse:: |
|
TrustedRedirectResponse:: |
protected | property | A list of trusted URLs, which are safe to redirect to. | |
TrustedRedirectResponse:: |
protected | function |
Returns whether the URL is considered as safe to redirect to. Overrides SecuredRedirectResponse:: |
|
TrustedRedirectResponse:: |
public | function | Sets the target URL to a trusted URL. | |
TrustedRedirectResponse:: |
public | function |
Creates a redirect response so that it conforms to the rules defined for a redirect status code. Overrides RedirectResponse:: |