class AssetDumper in Drupal 8

Dumps a CSS or JavaScript asset.

Hierarchy

• class \Drupal\Core\Asset\AssetDumper implements AssetDumperInterface

1 string reference to 'AssetDumper'

core.services.yml in core/core.services.yml

core/core.services.yml

2 services use AssetDumper

asset.css.dumper in core/core.services.yml

Drupal\Core\Asset\AssetDumper

asset.js.dumper in core/core.services.yml

Drupal\Core\Asset\AssetDumper

File

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

Namespace

Drupal\Core\Asset

class AssetDumper implements AssetDumperInterface {

  /**
   * 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 = NULL) {
    $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) {

    // Prefix filename to prevent blocking by firewalls which reject files
    // starting with "ad*".
    $filename = $file_extension . '_' . Crypt::hashBase64($data) . '.' . $file_extension;

    // Create the css/ or js/ path within the files folder.
    $path = 'public://' . $file_extension;
    $uri = $path . '/' . $filename;

    // Create the CSS or JS file.
    $this
      ->getFileSystem()
      ->prepareDirectory($path, FileSystemInterface::CREATE_DIRECTORY);
    try {
      if (!file_exists($uri) && !$this
        ->getFileSystem()
        ->saveData($data, $uri, FileSystemInterface::EXISTS_REPLACE)) {
        return FALSE;
      }
    } catch (FileException $e) {
      return FALSE;
    }

    // If CSS/JS gzip compression is enabled and the zlib extension is available
    // 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 (extension_loaded('zlib') && \Drupal::config('system.performance')
      ->get($file_extension . '.gzip')) {
      try {
        if (!file_exists($uri . '.gz') && !$this
          ->getFileSystem()
          ->saveData(gzencode($data, 9, FORCE_GZIP), $uri . '.gz', FileSystemInterface::EXISTS_REPLACE)) {
          return FALSE;
        }
      } catch (FileException $e) {
        return FALSE;
      }
    }
    return $uri;
  }

  /**
   * Helper method for returning the file system service.
   *
   * @return \Drupal\Core\File\FileSystemInterface
   *   The file system service.
   */
  private function getFileSystem() {
    if (!$this->fileSystem) {
      @trigger_error('\\Drupal\\Core\\File\\FileSystemInterface is a dependency of this class in Drupal 8.7.0 and will be required before Drupal 9.0.0. See https://www.drupal.org/node/3006851.', E_USER_DEPRECATED);
      $this->fileSystem = \Drupal::service('file_system');
    }
    return $this->fileSystem;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssetDumper::$fileSystem	protected	property	The file system service.
AssetDumper::dump	public	function	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. Overrides AssetDumperInterface::dump
AssetDumper::getFileSystem	private	function	Helper method for returning the file system service.
AssetDumper::__construct	public	function	AssetDumper constructor.