abstract class FileUsageBase

Defines the base class for database file usage backend.

Hierarchy

Expanded class hierarchy of FileUsageBase

File

drupal/core/modules/file/lib/Drupal/file/FileUsage/FileUsageBase.php, line 15
Definition of Drupal\file\FileUsage\FileUsageBase.

Namespace

Drupal\file\FileUsage
View source
abstract class FileUsageBase implements FileUsageInterface {

  /**
   * Implements Drupal\file\FileUsage\FileUsageInterface::add().
   */
  public function add(File $file, $module, $type, $id, $count = 1) {

    // Make sure that a used file is permament.
    if ($file->status != FILE_STATUS_PERMANENT) {
      $file->status = FILE_STATUS_PERMANENT;
      $file
        ->save();
    }
  }

  /**
   * Implements Drupal\file\FileUsage\FileUsageInterface::delete().
   */
  public function delete(File $file, $module, $type = NULL, $id = NULL, $count = 1) {

    // If there are no more remaining usages of this file, mark it as temporary,
    // which result in a delete through system_cron().
    $usage = file_usage()
      ->listUsage($file);
    if (empty($usage)) {
      $file->status = 0;
      $file
        ->save();
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
FileUsageBase::add public function Implements Drupal\file\FileUsage\FileUsageInterface::add(). Overrides FileUsageInterface::add 1
FileUsageBase::delete public function Implements Drupal\file\FileUsage\FileUsageInterface::delete(). Overrides FileUsageInterface::delete 1
FileUsageInterface::listUsage public function Determines where a file is used. 1