AssetDumper.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Asset/AssetDumper.php
  2. 8.9.x core/lib/Drupal/Core/Asset/AssetDumper.php
  3. 10 core/lib/Drupal/Core/Asset/AssetDumper.php

Namespace

Drupal\Core\Asset

File

core/lib/Drupal/Core/Asset/AssetDumper.php

View source
<?php

namespace Drupal\Core\Asset;

use Drupal\Component\Utility\Crypt;
use Drupal\Core\File\Exception\FileException;
use Drupal\Core\File\FileExists;
use Drupal\Core\File\FileSystemInterface;

/**
 * Dumps a CSS or JavaScript asset.
 */
class AssetDumper implements AssetDumperUriInterface {
    
    /**
     * The file system service.
     *
     * @var \Drupal\Core\File\FileSystemInterface
     */
    protected $fileSystem;
    
    /**
     * AssetDumper constructor.
     *
     * @param \Drupal\Core\File\FileSystemInterface $file_system
     *   The file handler.
     */
    public function __construct(FileSystemInterface $file_system) {
        $this->fileSystem = $file_system;
    }
    
    /**
     * {@inheritdoc}
     *
     * 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.
     */
    public function dump($data, $file_extension) {
        $path = 'assets://' . $file_extension;
        // Prefix filename to prevent blocking by firewalls which reject files
        // starting with "ad*".
        $filename = $file_extension . '_' . Crypt::hashBase64($data) . '.' . $file_extension;
        $uri = $path . '/' . $filename;
        return $this->dumpToUri($data, $file_extension, $uri);
    }
    
    /**
     * {@inheritdoc}
     */
    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;
    }

}

Classes

Title Deprecated Summary
AssetDumper Dumps a CSS or JavaScript asset.

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