function AssetDumper::dumpToUri

Same name in other branches
  1. 10 core/lib/Drupal/Core/Asset/AssetDumper.php \Drupal\Core\Asset\AssetDumper::dumpToUri()

Overrides AssetDumperUriInterface::dumpToUri

1 call to AssetDumper::dumpToUri()
AssetDumper::dump in core/lib/Drupal/Core/Asset/AssetDumper.php
The file name for the CSS or JS cache file is generated from the hash of the aggregated contents of the files in $data. This forces proxies and browsers to download new CSS when the CSS changes.

File

core/lib/Drupal/Core/Asset/AssetDumper.php, line 51

Class

AssetDumper
Dumps a CSS or JavaScript asset.

Namespace

Drupal\Core\Asset

Code

public function dumpToUri(string $data, string $file_extension, string $uri) : string {
    $path = 'assets://' . $file_extension;
    // Create the CSS or JS file.
    $this->fileSystem
        ->prepareDirectory($path, FileSystemInterface::CREATE_DIRECTORY);
    try {
        if (!file_exists($uri) && !$this->fileSystem
            ->saveData($data, $uri, FileExists::Replace)) {
            return FALSE;
        }
    } catch (FileException) {
        return FALSE;
    }
    // If CSS/JS gzip compression is enabled then create a gzipped version of
    // this file. This file is served conditionally to browsers that accept gzip
    // using .htaccess rules. It's possible that the rewrite rules in .htaccess
    // aren't working on this server, but there's no harm (other than the time
    // spent generating the file) in generating the file anyway. Sites on
    // servers where rewrite rules aren't working can set css.gzip to FALSE in
    // order to skip generating a file that won't be used.
    if (\Drupal::config('system.performance')->get($file_extension . '.gzip')) {
        try {
            if (!file_exists($uri . '.gz') && !$this->fileSystem
                ->saveData(gzencode($data, 9, FORCE_GZIP), $uri . '.gz', FileExists::Replace)) {
                return FALSE;
            }
        } catch (FileException) {
            return FALSE;
        }
    }
    return $uri;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.