class HtmlResponse in Zircon Profile 8
Same name in this branch
- 8 vendor/zendframework/zend-diactoros/src/Response/HtmlResponse.php \Zend\Diactoros\Response\HtmlResponse
- 8 core/lib/Drupal/Core/Render/HtmlResponse.php \Drupal\Core\Render\HtmlResponse
Same name and namespace in other branches
- 8.0 core/lib/Drupal/Core/Render/HtmlResponse.php \Drupal\Core\Render\HtmlResponse
A response that contains and can expose cacheability metadata and attachments.
Supports Drupal's caching concepts: cache tags for invalidation and cache contexts for variations.
Supports Drupal's idea of #attached metadata: libraries, settings, http_header and html_head.
Hierarchy
- class \Symfony\Component\HttpFoundation\Response
- class \Drupal\Core\Render\HtmlResponse implements CacheableResponseInterface, AttachmentsInterface uses CacheableResponseTrait, AttachmentsTrait
Expanded class hierarchy of HtmlResponse
See also
\Drupal\Core\Cache\CacheableResponse
\Drupal\Core\Render\AttachmentsInterface
\Drupal\Core\Render\AttachmentsTrait
3 files declare their use of HtmlResponse
- HtmlRenderer.php in core/
lib/ Drupal/ Core/ Render/ MainContent/ HtmlRenderer.php - Contains \Drupal\Core\Render\MainContent\HtmlRenderer.
- HtmlResponsePlaceholderStrategySubscriber.php in core/
lib/ Drupal/ Core/ EventSubscriber/ HtmlResponsePlaceholderStrategySubscriber.php - Contains \Drupal\Core\EventSubscriber\HtmlResponsePlaceholderStrategySubscriber.
- HtmlResponseSubscriber.php in core/
lib/ Drupal/ Core/ EventSubscriber/ HtmlResponseSubscriber.php - Contains \Drupal\Core\EventSubscriber\HtmlResponseSubscriber.
File
- core/
lib/ Drupal/ Core/ Render/ HtmlResponse.php, line 27 - Contains \Drupal\Core\Render\HtmlResponse.
Namespace
Drupal\Core\RenderView source
class HtmlResponse extends Response implements CacheableResponseInterface, AttachmentsInterface {
use CacheableResponseTrait;
use AttachmentsTrait;
/**
* {@inheritdoc}
*/
public function setContent($content) {
// A render array can automatically be converted to a string and set the
// necessary metadata.
if (is_array($content) && isset($content['#markup'])) {
$content += [
'#attached' => [
'html_response_attachment_placeholders' => [],
'placeholders' => [],
],
];
$this
->addCacheableDependency(CacheableMetadata::createFromRenderArray($content));
$this
->setAttachments($content['#attached']);
$content = $content['#markup'];
}
return parent::setContent($content);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AttachmentsTrait:: |
protected | property | The attachments for this response. | |
AttachmentsTrait:: |
public | function | ||
AttachmentsTrait:: |
public | function | ||
AttachmentsTrait:: |
public | function | ||
CacheableResponseTrait:: |
protected | property | The cacheability metadata. | |
CacheableResponseTrait:: |
public | function | ||
CacheableResponseTrait:: |
public | function | ||
HtmlResponse:: |
public | function |
Sets the response content. Overrides Response:: |
|
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:: |
public static | function | Factory method for chainability. | 4 |
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 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 | Constructor. | 10 |
Response:: |
public | function | Returns the Response as an HTTP string. |