CssCollectionRenderer.php
Same filename in other branches
Namespace
Drupal\Core\AssetFile
-
core/
lib/ Drupal/ Core/ Asset/ CssCollectionRenderer.php
View source
<?php
namespace Drupal\Core\Asset;
use Drupal\Core\DependencyInjection\DeprecatedServicePropertyTrait;
use Drupal\Core\File\FileUrlGeneratorInterface;
use Drupal\Core\State\StateInterface;
/**
* Renders CSS assets.
*/
class CssCollectionRenderer 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 CssCollectionRenderer.
*
* @param \Drupal\Core\Asset\AssetQueryStringInterface|\Drupal\Core\State\StateInterface $asset_query_string
* The asset query string.
* @param \Drupal\Core\File\FileUrlGeneratorInterface $file_url_generator
* The file URL generator.
*/
public function __construct(AssetQueryStringInterface|StateInterface $asset_query_string, FileUrlGeneratorInterface $file_url_generator) {
if ($asset_query_string instanceof StateInterface) {
@trigger_error('Calling ' . __METHOD__ . '() with an $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;
}
/**
* {@inheritdoc}
*/
public function render(array $css_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.
$query_string = $this->assetQueryString
->get();
// Defaults for LINK and STYLE elements.
$link_element_defaults = [
'#type' => 'html_tag',
'#tag' => 'link',
'#attributes' => [
'rel' => 'stylesheet',
],
];
foreach ($css_assets as $css_asset) {
$element = $link_element_defaults;
$element['#attributes']['media'] = $css_asset['media'];
switch ($css_asset['type']) {
// For file items, output a LINK tag for file CSS assets.
case 'file':
$element['#attributes']['href'] = $this->fileUrlGenerator
->generateString($css_asset['data']);
// Only add the cache-busting query string if this isn't an aggregate
// file.
if (!isset($css_asset['preprocessed'])) {
$query_string_separator = str_contains($css_asset['data'], '?') ? '&' : '?';
$element['#attributes']['href'] .= $query_string_separator . $query_string;
}
break;
case 'external':
$element['#attributes']['href'] = $css_asset['data'];
break;
default:
throw new \Exception('Invalid CSS asset type.');
}
// Merge any additional attributes.
if (!empty($css_asset['attributes'])) {
$element['#attributes'] += $css_asset['attributes'];
}
$elements[] = $element;
}
return $elements;
}
}
Classes
Title | Deprecated | Summary |
---|---|---|
CssCollectionRenderer | Renders CSS assets. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.