interface FileStorageInterface in Drupal 10

Defines an interface for file entity storage classes.

Hierarchy

• interface \Drupal\Core\Entity\EntityStorageInterface; interface \Drupal\Core\Entity\TranslatableRevisionableStorageInterface
  • interface \Drupal\Core\Entity\ContentEntityStorageInterface
    • interface \Drupal\file\FileStorageInterface

File

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

Namespace

Drupal\file

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);

}

Members

Name	Modifiers	Type	Description	Overrides
ContentEntityStorageInterface::createWithSampleValues	public	function	Creates an entity with sample field values.	2
EntityStorageInterface::create	public	function	Constructs a new entity object, without permanently saving it.	1
EntityStorageInterface::delete	public	function	Deletes permanently saved entities.	1
EntityStorageInterface::deleteRevision	public	function	Delete a specific entity revision.	4
EntityStorageInterface::FIELD_LOAD_CURRENT		constant	Load the most recent version of an entity's field data.
EntityStorageInterface::FIELD_LOAD_REVISION		constant	Load the version of an entity's field data specified in the entity.
EntityStorageInterface::getAggregateQuery	public	function	Gets an aggregated query instance.	1
EntityStorageInterface::getEntityClass	public	function	Retrieves the class name used to create the entity.	1
EntityStorageInterface::getEntityType	public	function	Gets the entity type definition.	1
EntityStorageInterface::getEntityTypeId	public	function	Gets the entity type ID.	1
EntityStorageInterface::getQuery	public	function	Gets an entity query instance.	1
EntityStorageInterface::hasData	public	function	Determines if the storage contains any data.	1
EntityStorageInterface::load	public	function	Loads one entity.	1
EntityStorageInterface::loadByProperties	public	function	Load entities by their property values.	1
EntityStorageInterface::loadMultiple	public	function	Loads one or more entities.	1
EntityStorageInterface::loadRevision	public	function	Load a specific entity revision.	4
EntityStorageInterface::loadUnchanged	public	function	Loads an unchanged entity from the database.	1
EntityStorageInterface::resetCache	public	function	Resets the internal entity cache.	1
EntityStorageInterface::restore	public	function	Restores a previously saved entity.	1
EntityStorageInterface::save	public	function	Saves the entity permanently.	1
FileStorageInterface::spaceUsed	public	function	Determines total disk space used by a single user or the whole filesystem.	1
RevisionableStorageInterface::getLatestRevisionId	public	function	Returns the latest revision identifier for an entity.	2
RevisionableStorageInterface::loadMultipleRevisions	public	function	Loads multiple entity revisions.	2
TranslatableRevisionableStorageInterface::createRevision	public	function	Creates a new revision starting off from the specified entity object. Overrides RevisionableStorageInterface::createRevision	2
TranslatableRevisionableStorageInterface::getLatestTranslationAffectedRevisionId	public	function	Returns the latest revision affecting the specified translation.	2
TranslatableStorageInterface::createTranslation	public	function	Constructs a new entity translation object, without permanently saving it.	2