class JsCollectionRenderer
Same name in other branches
- 9 core/lib/Drupal/Core/Asset/JsCollectionRenderer.php \Drupal\Core\Asset\JsCollectionRenderer
- 8.9.x core/lib/Drupal/Core/Asset/JsCollectionRenderer.php \Drupal\Core\Asset\JsCollectionRenderer
- 11.x core/lib/Drupal/Core/Asset/JsCollectionRenderer.php \Drupal\Core\Asset\JsCollectionRenderer
Renders JavaScript assets.
Hierarchy
- class \Drupal\Core\Asset\JsCollectionRenderer implements \Drupal\Core\Asset\AssetCollectionRendererInterface uses \Drupal\Core\DependencyInjection\DeprecatedServicePropertyTrait
Expanded class hierarchy of JsCollectionRenderer
1 string reference to 'JsCollectionRenderer'
- core.services.yml in core/
core.services.yml - core/core.services.yml
1 service uses JsCollectionRenderer
File
-
core/
lib/ Drupal/ Core/ Asset/ JsCollectionRenderer.php, line 14
Namespace
Drupal\Core\AssetView source
class JsCollectionRenderer implements AssetCollectionRendererInterface {
use DeprecatedServicePropertyTrait;
/**
* {@inheritdoc}
*/
protected array $deprecatedProperties = [
'state' => 'state',
];
/**
* The asset query string.
*
* @var \Drupal\Core\Asset\AssetQueryStringInterface
*/
protected AssetQueryStringInterface $assetQueryString;
/**
* The file URL generator.
*
* @var \Drupal\Core\File\FileUrlGeneratorInterface
*/
protected $fileUrlGenerator;
/**
* Constructs a JsCollectionRenderer.
*
* @param \Drupal\Core\State\StateInterface|\Drupal\Core\Asset\AssetQueryStringInterface $asset_query_string
* The asset query string.
* @param \Drupal\Core\File\FileUrlGeneratorInterface $file_url_generator
* The file URL generator.
* @param \Drupal\Component\Datetime\TimeInterface|null $time
* The time service.
*/
public function __construct(AssetQueryStringInterface|StateInterface $asset_query_string, FileUrlGeneratorInterface $file_url_generator, ?TimeInterface $time = NULL) {
if ($asset_query_string instanceof StateInterface) {
@trigger_error('Calling ' . __METHOD__ . '() with the $asset_query_string argument as \\Drupal\\Core\\State\\StateInterface instead of \\Drupal\\Core\\Asset\\AssetQueryStringInterface is deprecated in drupal:10.2.0 and will be required in drupal:11.0.0. See https://www.drupal.org/node/3358337', E_USER_DEPRECATED);
$asset_query_string = \Drupal::service('asset.query_string');
}
$this->assetQueryString = $asset_query_string;
$this->fileUrlGenerator = $file_url_generator;
if (!$time) {
@trigger_error('Calling ' . __METHOD__ . '() without the $time argument is deprecated in drupal:10.3.0 and it will be required in drupal:11.0.0. See https://www.drupal.org/node/3387233', E_USER_DEPRECATED);
$this->time = \Drupal::service(TimeInterface::class);
}
}
/**
* {@inheritdoc}
*
* This class evaluates the aggregation enabled/disabled condition on a group
* by group basis by testing whether an aggregate file has been made for the
* group rather than by testing the site-wide aggregation setting. This allows
* this class to work correctly even if modules have implemented custom
* logic for grouping and aggregating files.
*/
public function render(array $js_assets) {
$elements = [];
// A dummy query-string is added to filenames, to gain control over
// browser-caching. The string changes on every update or full cache
// flush, forcing browsers to load a new copy of the files, as the
// URL changed. Files that should not be cached get the request time as a
// query-string instead, to enforce reload on every page request.
$default_query_string = $this->assetQueryString
->get();
// Defaults for each SCRIPT element.
$element_defaults = [
'#type' => 'html_tag',
'#tag' => 'script',
'#value' => '',
];
// Loop through all JS assets.
foreach ($js_assets as $js_asset) {
$element = $element_defaults;
// Element properties that depend on item type.
switch ($js_asset['type']) {
case 'setting':
$element['#attributes'] = [
// This type attribute prevents this from being parsed as an
// inline script.
'type' => 'application/json',
'data-drupal-selector' => 'drupal-settings-json',
];
$element['#value'] = Json::encode($js_asset['data']);
break;
case 'file':
$query_string = $js_asset['version'] == -1 ? $default_query_string : 'v=' . $js_asset['version'];
$query_string_separator = str_contains($js_asset['data'], '?') ? '&' : '?';
$element['#attributes']['src'] = $this->fileUrlGenerator
->generateString($js_asset['data']);
// Only add the cache-busting query string if this isn't an aggregate
// file.
if (!isset($js_asset['preprocessed'])) {
$element['#attributes']['src'] .= $query_string_separator . ($js_asset['cache'] ? $query_string : $this->time
->getRequestTime());
}
break;
case 'external':
$element['#attributes']['src'] = $js_asset['data'];
break;
default:
throw new \Exception('Invalid JS asset type.');
}
// Attributes may only be set if this script is output independently.
if (!empty($element['#attributes']['src']) && !empty($js_asset['attributes'])) {
$element['#attributes'] += $js_asset['attributes'];
}
$elements[] = $element;
}
return $elements;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
DeprecatedServicePropertyTrait::__get | public | function | Allows to access deprecated/removed properties. | |
JsCollectionRenderer::$assetQueryString | protected | property | The asset query string. | |
JsCollectionRenderer::$deprecatedProperties | protected | property | ||
JsCollectionRenderer::$fileUrlGenerator | protected | property | The file URL generator. | |
JsCollectionRenderer::render | public | function | This class evaluates the aggregation enabled/disabled condition on a group by group basis by testing whether an aggregate file has been made for the group rather than by testing the site-wide aggregation setting. This allows this class to work… |
Overrides AssetCollectionRendererInterface::render |
JsCollectionRenderer::__construct | public | function | Constructs a JsCollectionRenderer. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.