blob: 0bae668512d962527cc690f7fa65ceef4f92295d (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
<?php
namespace Drupal\Core\Render;
use Drupal\Core\Cache\CacheableMetadata;
use Drupal\Core\Cache\CacheableResponseInterface;
use Drupal\Core\Cache\CacheableResponseTrait;
use Symfony\Component\HttpFoundation\Response;
/**
* 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.
*
* @see \Drupal\Core\Cache\CacheableResponse
* @see \Drupal\Core\Render\AttachmentsInterface
* @see \Drupal\Core\Render\AttachmentsTrait
*/
class HtmlResponse extends Response implements CacheableResponseInterface, AttachmentsInterface {
use CacheableResponseTrait;
use AttachmentsTrait;
/**
* Constructs a HtmlResponse object.
*
* @param array|string $content
* The response content, see setContent().
* @param int $status
* The response status code.
* @param array $headers
* An array of response headers.
*
* @throws \InvalidArgumentException
* When the HTTP status code is not valid.
*/
public function __construct($content = '', int $status = 200, array $headers = []) {
parent::__construct('', $status, $headers);
$this->setContent($content);
}
/**
* Sets the response content.
*
* @param mixed $content
* Content that can be cast to string, or a render array.
*
* @return $this
*/
public function setContent($content): static {
// 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);
}
}
|
