final class AssetFileStorage in Asset Injector 8.2

Class AssetFileStorage.

This asset file storage class implements a content-addressed file system where each file is stored in a location like so: public://asset_injector/[extension]/[name]-[md5].[extension] Note that the name and extension-dir are redundant and purely for DX.

Due to the nature of the config override system, the content of any asset config entity can vary on external factory beyond our control, be it language, domain, settings.php overrides or anything else. In other words, any asset entity can map to an arbitrary number of actual assets. Thus asset files are generated in AssetFileStorage::internalFileUri() with a file name that is unique by their content, and only deleted on cache flush.

@package Drupal\asset_injector

Hierarchy

• class \Drupal\asset_injector\AssetFileStorage

See also

asset_injector_page_attachments().

2 files declare their use of AssetFileStorage

AssetInjectorBase.php in src/Entity/AssetInjectorBase.php

asset_injector.module in ./asset_injector.module

Contains module asset_injector.

File

src/AssetFileStorage.php, line 26

Namespace

Drupal\asset_injector

final class AssetFileStorage {
  const DIRECTORY_URI = 'public://asset_injector';

  /**
   * Asset with file storage.
   *
   * @var AssetInjectorInterface
   */
  protected $asset;

  /**
   * AssetFileStorage constructor.
   *
   * @param AssetInjectorInterface $asset
   *   The asset.
   */
  public function __construct(AssetInjectorInterface $asset) {
    $this->asset = $asset;
  }

  /**
   * Create file and return internal uri.
   *
   * @return string
   *   Internal file URI using public:// stream wrapper.
   */
  public function createFile() {
    $internal_uri = self::internalFileUri();
    if (!is_file($internal_uri)) {
      $directory = dirname($internal_uri);
      $file_system = self::getFileSystemService();
      $file_system
        ->prepareDirectory($directory, FileSystemInterface::CREATE_DIRECTORY | FileSystemInterface::MODIFY_PERMISSIONS);
      $file_system
        ->saveData($this->asset
        ->getCode(), $internal_uri, FileSystemInterface::EXISTS_REPLACE);
    }
    return $internal_uri;
  }

  /**
   * Delete files for an asset.
   *
   * Yes, we can have multiple files for an asset configuration, if we have
   * overrides.
   */
  public function deleteFiles() {
    $pattern = $this
      ->internalFileUri(TRUE);
    $paths = glob($pattern);
    foreach ($paths as $path) {
      self::getFileSystemService()
        ->delete($path);
    }
  }

  /**
   * Create internal file URI or pattern.
   *
   * @param bool $pattern
   *   Get Pattern instead of internal file URI.
   *
   * @return string
   *   File uri.
   */
  protected function internalFileUri($pattern = FALSE) {
    $name = $this->asset
      ->id();
    $extension = $this->asset
      ->extension();
    $hash = $pattern ? '*' : md5($this->asset
      ->getCode());
    $all_assets_directory = self::DIRECTORY_URI;
    if ($pattern) {

      // glob() does not understand stream wrappers. Sigh.
      $all_assets_directory = self::getFileSystemService()
        ->realpath($all_assets_directory);
    }
    $internal_uri = "{$all_assets_directory}/{$extension}/{$name}-{$hash}.{$extension}";
    return $internal_uri;
  }

  /**
   * Get the Drupal file system service.
   *
   * @return \Drupal\Core\File\FileSystemInterface
   *   File System service.
   */
  protected static function getFileSystemService() {
    return \Drupal::service('file_system');
  }

  /**
   * Delete all asset files.
   *
   * @see asset_injector_cache_flush()
   */
  public static function deleteAllFiles() {
    if (file_exists(self::DIRECTORY_URI)) {
      self::getFileSystemService()
        ->deleteRecursive(self::DIRECTORY_URI);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssetFileStorage::$asset	protected	property	Asset with file storage.
AssetFileStorage::createFile	public	function	Create file and return internal uri.
AssetFileStorage::deleteAllFiles	public static	function	Delete all asset files.
AssetFileStorage::deleteFiles	public	function	Delete files for an asset.
AssetFileStorage::DIRECTORY_URI		constant
AssetFileStorage::getFileSystemService	protected static	function	Get the Drupal file system service.
AssetFileStorage::internalFileUri	protected	function	Create internal file URI or pattern.
AssetFileStorage::__construct	public	function	AssetFileStorage constructor.