class File in Zircon Profile 8

Defines the file entity class.

Plugin annotation

@ContentEntityType(
  id = "file",
  label = @Translation("File"),
  handlers = {
    "storage" = "Drupal\file\FileStorage",
    "storage_schema" = "Drupal\file\FileStorageSchema",
    "access" = "Drupal\file\FileAccessControlHandler",
    "views_data" = "Drupal\file\FileViewsData",
  },
  base_table = "file_managed",
  entity_keys = {
    "id" = "fid",
    "label" = "filename",
    "langcode" = "langcode",
    "uuid" = "uuid"
  }
)

Hierarchy

• class \Drupal\Core\Entity\Entity implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
  • class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, ContentEntityInterface
    • class \Drupal\file\Entity\File implements FileInterface uses EntityChangedTrait

45 files declare their use of File

CopyTest.php in core/modules/file/src/Tests/CopyTest.php

Contains \Drupal\file\Tests\CopyTest.

DeleteTest.php in core/modules/file/src/Tests/DeleteTest.php

Contains \Drupal\file\Tests\DeleteTest.

EntityCrudHookTest.php in core/modules/system/src/Tests/Entity/EntityCrudHookTest.php

Contains \Drupal\system\Tests\Entity\EntityCrudHookTest.

EntityReferenceItemTest.php in core/modules/field/src/Tests/EntityReference/EntityReferenceItemTest.php

Contains \Drupal\field\Tests\EntityReference\EntityReferenceItemTest.

ExtensionViewsFieldTest.php in core/modules/file/src/Tests/Views/ExtensionViewsFieldTest.php

Contains \Drupal\file\Tests\Views\ExtensionViewsFieldTest.

... See full list

23 string references to 'File'

DirectoryTest::testFileCheckDirectoryHandling in core/modules/system/src/Tests/File/DirectoryTest.php

Test directory handling functions.

DirectoryTest::testFileCheckLocalDirectoryHandling in core/modules/system/src/Tests/File/DirectoryTest.php

Test local directory handling functions.

DirectoryTest::testFileCreateNewFilepath in core/modules/system/src/Tests/File/DirectoryTest.php

This will take a directory and path, and find a valid filepath that is not taken by another file.

DirectoryTest::testFileDestination in core/modules/system/src/Tests/File/DirectoryTest.php

This will test the filepath for a destination based on passed flags and whether or not the file exists.

file.destination.schema.yml in core/modules/file/config/schema/file.destination.schema.yml

core/modules/file/config/schema/file.destination.schema.yml

... See full list

File

core/modules/file/src/Entity/File.php, line 39

Contains \Drupal\file\Entity\File.

Namespace

Drupal\file\Entity

class File extends ContentEntityBase implements FileInterface {
  use EntityChangedTrait;

  /**
   * {@inheritdoc}
   */
  public function getFilename() {
    return $this
      ->get('filename')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setFilename($filename) {
    $this
      ->get('filename')->value = $filename;
  }

  /**
   * {@inheritdoc}
   */
  public function getFileUri() {
    return $this
      ->get('uri')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setFileUri($uri) {
    $this
      ->get('uri')->value = $uri;
  }

  /**
   * {@inheritdoc}
   */
  public function url($rel = 'canonical', $options = array()) {
    return file_create_url($this
      ->getFileUri());
  }

  /**
   * {@inheritdoc}
   */
  public function getMimeType() {
    return $this
      ->get('filemime')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setMimeType($mime) {
    $this
      ->get('filemime')->value = $mime;
  }

  /**
   * {@inheritdoc}
   */
  public function getSize() {
    return $this
      ->get('filesize')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setSize($size) {
    $this
      ->get('filesize')->value = $size;
  }

  /**
   * {@inheritdoc}
   */
  public function getCreatedTime() {
    return $this
      ->get('created')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function getOwner() {
    return $this
      ->get('uid')->entity;
  }

  /**
   * {@inheritdoc}
   */
  public function getOwnerId() {
    return $this
      ->get('uid')->target_id;
  }

  /**
   * {@inheritdoc}
   */
  public function setOwnerId($uid) {
    $this
      ->set('uid', $uid);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function setOwner(UserInterface $account) {
    $this
      ->set('uid', $account
      ->id());
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function isPermanent() {
    return $this
      ->get('status')->value == FILE_STATUS_PERMANENT;
  }

  /**
   * {@inheritdoc}
   */
  public function isTemporary() {
    return $this
      ->get('status')->value == 0;
  }

  /**
   * {@inheritdoc}
   */
  public function setPermanent() {
    $this
      ->get('status')->value = FILE_STATUS_PERMANENT;
  }

  /**
   * {@inheritdoc}
   */
  public function setTemporary() {
    $this
      ->get('status')->value = 0;
  }

  /**
   * {@inheritdoc}
   */
  public static function preCreate(EntityStorageInterface $storage, array &$values) {

    // Automatically detect filename if not set.
    if (!isset($values['filename']) && isset($values['uri'])) {
      $values['filename'] = drupal_basename($values['uri']);
    }

    // Automatically detect filemime if not set.
    if (!isset($values['filemime']) && isset($values['uri'])) {
      $values['filemime'] = \Drupal::service('file.mime_type.guesser')
        ->guess($values['uri']);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function preSave(EntityStorageInterface $storage) {
    parent::preSave($storage);
    $this
      ->setSize(filesize($this
      ->getFileUri()));
  }

  /**
   * {@inheritdoc}
   */
  public static function preDelete(EntityStorageInterface $storage, array $entities) {
    parent::preDelete($storage, $entities);
    foreach ($entities as $entity) {

      // Delete all remaining references to this file.
      $file_usage = \Drupal::service('file.usage')
        ->listUsage($entity);
      if (!empty($file_usage)) {
        foreach ($file_usage as $module => $usage) {
          \Drupal::service('file.usage')
            ->delete($entity, $module);
        }
      }

      // Delete the actual file. Failures due to invalid files and files that
      // were already deleted are logged to watchdog but ignored, the
      // corresponding file entity will be deleted.
      file_unmanaged_delete($entity
        ->getFileUri());
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $fields['fid'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('File ID'))
      ->setDescription(t('The file ID.'))
      ->setReadOnly(TRUE)
      ->setSetting('unsigned', TRUE);
    $fields['uuid'] = BaseFieldDefinition::create('uuid')
      ->setLabel(t('UUID'))
      ->setDescription(t('The file UUID.'))
      ->setReadOnly(TRUE);
    $fields['langcode'] = BaseFieldDefinition::create('language')
      ->setLabel(t('Language code'))
      ->setDescription(t('The file language code.'));
    $fields['uid'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('User ID'))
      ->setDescription(t('The user ID of the file.'))
      ->setSetting('target_type', 'user');
    $fields['filename'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Filename'))
      ->setDescription(t('Name of the file with no path components.'));
    $fields['uri'] = BaseFieldDefinition::create('uri')
      ->setLabel(t('URI'))
      ->setDescription(t('The URI to access the file (either local or remote).'))
      ->setSetting('max_length', 255)
      ->setSetting('case_sensitive', TRUE)
      ->addConstraint('FileUriUnique');
    $fields['filemime'] = BaseFieldDefinition::create('string')
      ->setLabel(t('File MIME type'))
      ->setSetting('is_ascii', TRUE)
      ->setDescription(t("The file's MIME type."));
    $fields['filesize'] = BaseFieldDefinition::create('integer')
      ->setLabel(t('File size'))
      ->setDescription(t('The size of the file in bytes.'))
      ->setSetting('unsigned', TRUE)
      ->setSetting('size', 'big');
    $fields['status'] = BaseFieldDefinition::create('boolean')
      ->setLabel(t('Status'))
      ->setDescription(t('The status of the file, temporary (FALSE) and permanent (TRUE).'))
      ->setDefaultValue(FALSE);
    $fields['created'] = BaseFieldDefinition::create('created')
      ->setLabel(t('Created'))
      ->setDescription(t('The timestamp that the file was created.'));
    $fields['changed'] = BaseFieldDefinition::create('changed')
      ->setLabel(t('Changed'))
      ->setDescription(t('The timestamp that the file was last changed.'));
    return $fields;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContentEntityBase::$activeLangcode	protected	property	Language code identifying the entity active language.
ContentEntityBase::$defaultLangcode	protected	property	Local cache for the default language code.
ContentEntityBase::$defaultLangcodeKey	protected	property	The default langcode entity key.
ContentEntityBase::$entityKeys	protected	property	Holds untranslatable entity keys such as the ID, bundle, and revision ID.
ContentEntityBase::$fieldDefinitions	protected	property	Local cache for field definitions.
ContentEntityBase::$fields	protected	property	The array of fields, each being an instance of FieldItemListInterface.
ContentEntityBase::$isDefaultRevision	protected	property	Indicates whether this is the default revision.
ContentEntityBase::$langcodeKey	protected	property	The language entity key.
ContentEntityBase::$languages	protected	property	Local cache for the available language objects.
ContentEntityBase::$newRevision	protected	property	Boolean indicating whether a new revision should be created on save.
ContentEntityBase::$translatableEntityKeys	protected	property	Holds translatable entity keys such as the label.
ContentEntityBase::$translationInitialize	protected	property	A flag indicating whether a translation object is being initialized.
ContentEntityBase::$translations	protected	property	An array of entity translation metadata.
ContentEntityBase::$validated	protected	property	Whether entity validation was performed.
ContentEntityBase::$validationRequired	protected	property	Whether entity validation is required before saving the entity.
ContentEntityBase::$values	protected	property	The plain data values of the contained fields.
ContentEntityBase::access	public	function	Checks data value access. Overrides Entity::access	1
ContentEntityBase::addTranslation	public	function	Adds a new translation to the translatable object. Overrides TranslatableInterface::addTranslation
ContentEntityBase::bundle	public	function	Gets the bundle of the entity. Overrides Entity::bundle
ContentEntityBase::bundleFieldDefinitions	public static	function	Provides field definitions for a specific bundle. Overrides FieldableEntityInterface::bundleFieldDefinitions	3
ContentEntityBase::clearTranslationCache	protected	function	Clear entity translation object cache to remove stale references.
ContentEntityBase::createDuplicate	public	function	Creates a duplicate of the entity. Overrides Entity::createDuplicate	1
ContentEntityBase::get	public	function	Gets a field item list. Overrides FieldableEntityInterface::get
ContentEntityBase::getEntityKey	protected	function	Gets the value of the given entity key, if defined.
ContentEntityBase::getFieldDefinition	public	function	Gets the definition of a contained field. Overrides FieldableEntityInterface::getFieldDefinition
ContentEntityBase::getFieldDefinitions	public	function	Gets an array of field definitions of all contained fields. Overrides FieldableEntityInterface::getFieldDefinitions
ContentEntityBase::getFields	public	function	Gets an array of all field item lists. Overrides FieldableEntityInterface::getFields
ContentEntityBase::getIterator	public	function
ContentEntityBase::getLanguages	protected	function
ContentEntityBase::getRevisionId	public	function	Gets the revision identifier of the entity. Overrides RevisionableInterface::getRevisionId
ContentEntityBase::getTranslatableFields	public	function	Gets an array of field item lists for translatable fields. Overrides FieldableEntityInterface::getTranslatableFields
ContentEntityBase::getTranslatedField	protected	function	Gets a translated field.
ContentEntityBase::getTranslation	public	function	Gets a translation of the data. Overrides TranslatableInterface::getTranslation
ContentEntityBase::getTranslationLanguages	public	function	Returns the languages the data is translated to. Overrides TranslatableInterface::getTranslationLanguages
ContentEntityBase::getUntranslated	public	function	Returns the translatable object referring to the original language. Overrides TranslatableInterface::getUntranslated
ContentEntityBase::hasField	public	function	Determines whether the entity has a field with the given name. Overrides FieldableEntityInterface::hasField
ContentEntityBase::hasTranslation	public	function	Returns TRUE there is a translation for the given language code. Overrides TranslatableInterface::hasTranslation
ContentEntityBase::hasTranslationChanges	public	function	Determines if the current translation of the entity has unsaved changes. Overrides ContentEntityInterface::hasTranslationChanges
ContentEntityBase::id	public	function	Gets the identifier. Overrides Entity::id
ContentEntityBase::initializeTranslation	protected	function	Instantiates a translation object for an existing translation.
ContentEntityBase::isDefaultRevision	public	function	Checks if this entity is the default revision. Overrides RevisionableInterface::isDefaultRevision
ContentEntityBase::isDefaultTranslation	public	function	Checks whether the translation is the default one. Overrides TranslatableInterface::isDefaultTranslation
ContentEntityBase::isNewRevision	public	function	Determines whether a new revision should be created on save. Overrides RevisionableInterface::isNewRevision
ContentEntityBase::isNewTranslation	public	function	Checks whether the translation is new. Overrides TranslatableInterface::isNewTranslation
ContentEntityBase::isRevisionTranslationAffected	public	function	Checks whether the current translation is affected by the current revision. Overrides ContentEntityInterface::isRevisionTranslationAffected
ContentEntityBase::isTranslatable	public	function	Returns the translation support status. Overrides TranslatableInterface::isTranslatable
ContentEntityBase::isValidationRequired	public	function	Checks whether entity validation is required before saving the entity. Overrides FieldableEntityInterface::isValidationRequired
ContentEntityBase::label	public	function	Gets the label of the entity. Overrides Entity::label	3
ContentEntityBase::language	public	function	Gets the language of the entity. Overrides Entity::language
ContentEntityBase::onChange	public	function	Reacts to changes to a field. Overrides FieldableEntityInterface::onChange
ContentEntityBase::postCreate	public	function	Acts on an entity after it is created but before hooks are invoked. Overrides Entity::postCreate
ContentEntityBase::preSaveRevision	public	function	Acts on a revision before it gets saved. Overrides RevisionableInterface::preSaveRevision	2
ContentEntityBase::referencedEntities	public	function	Gets a list of entities referenced by this entity. Overrides Entity::referencedEntities	1
ContentEntityBase::removeTranslation	public	function	Removes the translation identified by the given language code. Overrides TranslatableInterface::removeTranslation
ContentEntityBase::set	public	function	Sets a field value. Overrides FieldableEntityInterface::set
ContentEntityBase::setDefaultLangcode	protected	function	Populates the local cache for the default language code.
ContentEntityBase::setNewRevision	public	function	Enforces an entity to be saved as a new revision. Overrides RevisionableInterface::setNewRevision
ContentEntityBase::setRevisionTranslationAffected	public	function	Marks the current revision translation as affected. Overrides ContentEntityInterface::setRevisionTranslationAffected
ContentEntityBase::setValidationRequired	public	function	Sets whether entity validation is required before saving the entity. Overrides FieldableEntityInterface::setValidationRequired
ContentEntityBase::toArray	public	function	Gets an array of all property values. Overrides Entity::toArray
ContentEntityBase::TRANSLATION_CREATED		constant	Status code identifying a newly created translation.
ContentEntityBase::TRANSLATION_EXISTING		constant	Status code identifying an existing translation.
ContentEntityBase::TRANSLATION_REMOVED		constant	Status code identifying a removed translation.
ContentEntityBase::updateFieldLangcodes	protected	function	Updates language for already instantiated fields.
ContentEntityBase::updateOriginalValues	public	function	Updates the original values with the interim changes.
ContentEntityBase::uuid	public	function	Gets the entity UUID (Universally Unique Identifier). Overrides Entity::uuid
ContentEntityBase::validate	public	function	Validates the currently set values. Overrides FieldableEntityInterface::validate
ContentEntityBase::__clone	public	function	Magic method: Implements a deep clone.
ContentEntityBase::__construct	public	function	Constructs an Entity object. Overrides Entity::__construct
ContentEntityBase::__get	public	function	Implements the magic method for getting object properties.
ContentEntityBase::__isset	public	function	Implements the magic method for isset().
ContentEntityBase::__set	public	function	Implements the magic method for setting object properties.
ContentEntityBase::__sleep	public	function	Overrides Entity::__sleep
ContentEntityBase::__unset	public	function	Implements the magic method for unset().
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function	Aliased as: traitSleep	1
DependencySerializationTrait::__wakeup	public	function		2
Entity::$enforceIsNew	protected	property	Boolean indicating whether the entity should be forced to be new.
Entity::$entityTypeId	protected	property	The entity type.
Entity::$typedData	protected	property	A typed data object wrapping this entity.
Entity::create	public static	function	Overrides EntityInterface::create
Entity::delete	public	function	Deletes an entity permanently. Overrides EntityInterface::delete	2
Entity::enforceIsNew	public	function	Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
Entity::entityManager Deprecated	protected	function	Gets the entity manager.
Entity::entityTypeManager	protected	function	Gets the entity type manager.
Entity::getCacheContexts	public	function	The cache contexts associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheContexts
Entity::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides RefinableCacheableDependencyTrait::getCacheMaxAge
Entity::getCacheTags	public	function	The cache tags associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheTags
Entity::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface::getCacheTagsToInvalidate	3
Entity::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
Entity::getConfigDependencyName	public	function	Gets the configuration dependency name. Overrides EntityInterface::getConfigDependencyName	1
Entity::getConfigTarget	public	function	Gets the configuration target identifier for the entity. Overrides EntityInterface::getConfigTarget	1
Entity::getEntityType	public	function	Gets the entity type definition. Overrides EntityInterface::getEntityType
Entity::getEntityTypeId	public	function	Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
Entity::getOriginalId	public	function	Gets the original ID. Overrides EntityInterface::getOriginalId	1
Entity::getTypedData	public	function	Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
Entity::hasLinkTemplate	public	function	Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
Entity::invalidateTagsOnDelete	protected static	function	Invalidates an entity's cache tags upon delete.	1
Entity::invalidateTagsOnSave	protected	function	Invalidates an entity's cache tags upon save.	1
Entity::isNew	public	function	Determines whether the entity is new. Overrides EntityInterface::isNew	2
Entity::languageManager	protected	function	Gets the language manager.
Entity::link	public	function	Deprecated way of generating a link to the entity. See toLink(). Overrides EntityInterface::link	1
Entity::linkTemplates	protected	function	Gets an array link templates.	1
Entity::load	public static	function	Overrides EntityInterface::load
Entity::loadMultiple	public static	function	Overrides EntityInterface::loadMultiple
Entity::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete	14
Entity::postLoad	public static	function	Acts on loaded entities. Overrides EntityInterface::postLoad	2
Entity::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave	20
Entity::save	public	function	Saves an entity permanently. Overrides EntityInterface::save	2
Entity::setOriginalId	public	function	Sets the original ID. Overrides EntityInterface::setOriginalId	1
Entity::toLink	public	function	Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
Entity::toUrl	public	function	Gets the URL object for the entity. Overrides EntityInterface::toUrl	1
Entity::uriRelationships	public	function	Returns a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
Entity::urlInfo	public	function	Gets the URL object for the entity. Overrides EntityInterface::urlInfo	1
Entity::urlRouteParameters	protected	function	Gets an array of placeholders for this entity.	1
Entity::uuidGenerator	protected	function	Gets the UUID generator.
EntityChangedTrait::getChangedTime	public	function	Gets the timestamp of the last entity change for the current translation.
EntityChangedTrait::getChangedTimeAcrossTranslations	public	function	Returns the timestamp of the last entity change across all translations.
EntityChangedTrait::setChangedTime	public	function	Sets the timestamp of the last entity change for the current translation.
File::baseFieldDefinitions	public static	function	Provides base field definitions for an entity type. Overrides FieldableEntityInterface::baseFieldDefinitions
File::getCreatedTime	public	function	Returns the file entity creation timestamp. Overrides FileInterface::getCreatedTime
File::getFilename	public	function	Returns the name of the file. Overrides FileInterface::getFilename
File::getFileUri	public	function	Returns the URI of the file. Overrides FileInterface::getFileUri
File::getMimeType	public	function	Returns the MIME type of the file. Overrides FileInterface::getMimeType
File::getOwner	public	function	Returns the entity owner's user entity. Overrides EntityOwnerInterface::getOwner
File::getOwnerId	public	function	Returns the entity owner's user ID. Overrides EntityOwnerInterface::getOwnerId
File::getSize	public	function	Returns the size of the file. Overrides FileInterface::getSize
File::isPermanent	public	function	Returns TRUE if the file is permanent. Overrides FileInterface::isPermanent
File::isTemporary	public	function	Returns TRUE if the file is temporary. Overrides FileInterface::isTemporary
File::preCreate	public static	function	Changes the values of an entity before it is created. Overrides Entity::preCreate
File::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides Entity::preDelete
File::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides ContentEntityBase::preSave
File::setFilename	public	function	Sets the name of the file. Overrides FileInterface::setFilename
File::setFileUri	public	function	Sets the URI of the file. Overrides FileInterface::setFileUri
File::setMimeType	public	function	Sets the MIME type of the file. Overrides FileInterface::setMimeType
File::setOwner	public	function	Sets the entity owner's user entity. Overrides EntityOwnerInterface::setOwner
File::setOwnerId	public	function	Sets the entity owner's user ID. Overrides EntityOwnerInterface::setOwnerId
File::setPermanent	public	function	Sets the file status to permanent. Overrides FileInterface::setPermanent
File::setSize	public	function	Sets the size of the file. Overrides FileInterface::setSize
File::setTemporary	public	function	Sets the file status to temporary. Overrides FileInterface::setTemporary
File::url	public	function	Gets the public URL for this entity. Overrides Entity::url
RefinableCacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
RefinableCacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
RefinableCacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function