interface FileStorageInterface

Same name and namespace in other branches
  1. 11.x core/modules/file/src/FileStorageInterface.php \Drupal\file\FileStorageInterface

Defines an interface for file entity storage classes.

Hierarchy

Expanded class hierarchy of FileStorageInterface

All classes that implement FileStorageInterface

File

core/modules/file/src/FileStorageInterface.php, line 10

Namespace

Drupal\file
View source
interface FileStorageInterface extends ContentEntityStorageInterface {
  
  /**
   * Determines total disk space used by a single user or the whole filesystem.
   *
   * @param int $uid
   *   Optional. A user id, specifying NULL returns the total space used by all
   *   non-temporary files.
   * @param int $status
   *   (Optional) The file status to consider. The default is to only
   *   consider files in status FileInterface::STATUS_PERMANENT.
   *
   * @return int
   *   An integer containing the number of bytes used.
   */
  public function spaceUsed($uid = NULL, $status = FileInterface::STATUS_PERMANENT);

}

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