interface FileInterface
Same name and namespace in other branches
- 8.9.x core/modules/file/src/FileInterface.php \Drupal\file\FileInterface
- 10 core/modules/file/src/FileInterface.php \Drupal\file\FileInterface
- 11.x core/modules/file/src/FileInterface.php \Drupal\file\FileInterface
Defines getter and setter methods for file entity base fields.
Hierarchy
- interface \Drupal\Core\Entity\ContentEntityInterface implements \Drupal\Core\Entity\Traversable, \Drupal\Core\Entity\FieldableEntityInterface, \Drupal\Core\Entity\TranslatableRevisionableInterface, \Drupal\Core\Entity\SynchronizableInterface; interface \Drupal\Core\Entity\EntityChangedInterface implements \Drupal\Core\Entity\EntityInterface; interface \Drupal\user\EntityOwnerInterface
- interface \Drupal\file\FileInterface implements \Drupal\Core\Entity\ContentEntityInterface, \Drupal\Core\Entity\EntityChangedInterface, \Drupal\user\EntityOwnerInterface
Expanded class hierarchy of FileInterface
All classes that implement FileInterface
Related topics
36 files declare their use of FileInterface
- CKEditor5ImageController.php in core/
modules/ ckeditor5/ src/ Controller/ CKEditor5ImageController.php - claro.theme in core/
themes/ claro/ claro.theme - Functions to support theming in the Claro theme.
- ComputedFileUrlTest.php in core/
modules/ file/ tests/ src/ Kernel/ ComputedFileUrlTest.php - DatabaseFileUsageBackend.php in core/
modules/ file/ src/ FileUsage/ DatabaseFileUsageBackend.php - EditorFileReference.php in core/
modules/ editor/ src/ Plugin/ Filter/ EditorFileReference.php
File
-
core/
modules/ file/ src/ FileInterface.php, line 14
Namespace
Drupal\fileView source
interface FileInterface extends ContentEntityInterface, EntityChangedInterface, EntityOwnerInterface {
/**
* Indicates that the file is permanent and should not be deleted.
*
* Temporary files older than the system.file.temporary_maximum_age will be
* removed during cron runs if cleanup is not disabled. (Permanent files will
* not be removed during the file garbage collection process.)
*/
const STATUS_PERMANENT = 1;
/**
* Returns the name of the file.
*
* This may differ from the basename of the URI if the file is renamed to
* avoid overwriting an existing file.
*
* @return string
* Name of the file.
*/
public function getFilename();
/**
* Sets the name of the file.
*
* @param string $filename
* The file name that corresponds to this file. May differ from the basename
* of the URI and changing the filename does not change the URI.
*/
public function setFilename($filename);
/**
* Returns the URI of the file.
*
* @return string
* The URI of the file, e.g. public://directory/file.jpg.
*/
public function getFileUri();
/**
* Sets the URI of the file.
*
* @param string $uri
* The URI of the file, e.g. public://directory/file.jpg. Does not change
* the location of the file.
*/
public function setFileUri($uri);
/**
* Creates a file URL for the URI of this file.
*
* @param bool $relative
* (optional) Whether the URL should be root-relative, defaults to TRUE.
*
* @return string
* A string containing a URL that may be used to access the file.
*
* @see \Drupal\Core\File\FileUrlGeneratorInterface
*/
public function createFileUrl($relative = TRUE);
/**
* Returns the MIME type of the file.
*
* @return string
* The MIME type of the file, e.g. image/jpeg or text/xml.
*/
public function getMimeType();
/**
* Sets the MIME type of the file.
*
* @param string $mime
* The MIME type of the file, e.g. image/jpeg or text/xml.
*/
public function setMimeType($mime);
/**
* Returns the size of the file.
*
* @return string
* The size of the file in bytes.
*/
public function getSize();
/**
* Sets the size of the file.
*
* @param int $size
* The size of the file in bytes.
*/
public function setSize($size);
/**
* Returns TRUE if the file is permanent.
*
* @return bool
* TRUE if the file status is permanent.
*/
public function isPermanent();
/**
* Returns TRUE if the file is temporary.
*
* @return bool
* TRUE if the file status is temporary.
*/
public function isTemporary();
/**
* Sets the file status to permanent.
*/
public function setPermanent();
/**
* Sets the file status to temporary.
*/
public function setTemporary();
/**
* Returns the file entity creation timestamp.
*
* @return int
* Creation timestamp of the file entity.
*/
public function getCreatedTime();
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
AccessibleInterface::access | public | function | Checks data value access. | 9 | |
CacheableDependencyInterface::getCacheContexts | public | function | The cache contexts associated with this object. | 34 | |
CacheableDependencyInterface::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | 34 | |
CacheableDependencyInterface::getCacheTags | public | function | The cache tags associated with this object. | 27 | |
EntityChangedInterface::getChangedTime | public | function | Gets the timestamp of the last entity change for the current translation. | ||
EntityChangedInterface::getChangedTimeAcrossTranslations | public | function | Gets the timestamp of the last entity change across all translations. | ||
EntityChangedInterface::setChangedTime | public | function | Sets the timestamp of the last entity change for the current translation. | ||
EntityInterface::bundle | public | function | Gets the bundle of the entity. | 2 | |
EntityInterface::create | public static | function | Constructs a new entity object, without permanently saving it. | 2 | |
EntityInterface::createDuplicate | public | function | Creates a duplicate of the entity. | 2 | |
EntityInterface::delete | public | function | Deletes an entity permanently. | 2 | |
EntityInterface::enforceIsNew | public | function | Enforces an entity to be new. | 2 | |
EntityInterface::getCacheTagsToInvalidate | public | function | Returns the cache tags that should be used to invalidate caches. | 2 | |
EntityInterface::getConfigDependencyKey | public | function | Gets the key that is used to store configuration dependencies. | 2 | |
EntityInterface::getConfigDependencyName | public | function | Gets the configuration dependency name. | 2 | |
EntityInterface::getConfigTarget | public | function | Gets the configuration target identifier for the entity. | 2 | |
EntityInterface::getEntityType | public | function | Gets the entity type definition. | 2 | |
EntityInterface::getEntityTypeId | public | function | Gets the ID of the type of the entity. | 2 | |
EntityInterface::getOriginalId | public | function | Gets the original ID. | 2 | |
EntityInterface::getTypedData | public | function | Gets a typed data object for this entity object. | 2 | |
EntityInterface::hasLinkTemplate | public | function | Indicates if a link template exists for a given key. | 2 | |
EntityInterface::id | public | function | Gets the identifier. | 2 | |
EntityInterface::isNew | public | function | Determines whether the entity is new. | 2 | |
EntityInterface::label | public | function | Gets the label of the entity. | 2 | |
EntityInterface::language | public | function | Gets the language of the entity. | 2 | |
EntityInterface::load | public static | function | Loads an entity. | 2 | |
EntityInterface::loadMultiple | public static | function | Loads one or more entities. | 2 | |
EntityInterface::postCreate | public | function | Acts on a created entity before hooks are invoked. | 2 | |
EntityInterface::postDelete | public static | function | Acts on deleted entities before the delete hook is invoked. | 2 | |
EntityInterface::postLoad | public static | function | Acts on loaded entities. | 3 | |
EntityInterface::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. | 2 | |
EntityInterface::preCreate | public static | function | Changes the values of an entity before it is created. | 2 | |
EntityInterface::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. | 2 | |
EntityInterface::preSave | public | function | Acts on an entity before the presave hook is invoked. | 2 | |
EntityInterface::referencedEntities | public | function | Gets a list of entities referenced by this entity. | 2 | |
EntityInterface::save | public | function | Saves an entity permanently. | 2 | |
EntityInterface::setOriginalId | public | function | Sets the original ID. | 2 | |
EntityInterface::toLink | public | function | Generates the HTML for a link to this entity. | 2 | |
EntityInterface::toUrl | public | function | Gets the URL object for the entity. | 2 | |
EntityInterface::uriRelationships | public | function | Gets a list of URI relationships supported by this entity. | 2 | |
EntityInterface::uuid | public | function | Gets the entity UUID (Universally Unique Identifier). | 2 | |
EntityOwnerInterface::getOwner | public | function | Returns the entity owner's user entity. | 1 | |
EntityOwnerInterface::getOwnerId | public | function | Returns the entity owner's user ID. | 1 | |
EntityOwnerInterface::setOwner | public | function | Sets the entity owner's user entity. | 1 | |
EntityOwnerInterface::setOwnerId | public | function | Sets the entity owner's user ID. | 1 | |
FieldableEntityInterface::baseFieldDefinitions | public static | function | Provides base field definitions for an entity type. | 2 | |
FieldableEntityInterface::bundleFieldDefinitions | public static | function | Provides field definitions for a specific bundle. | 2 | |
FieldableEntityInterface::get | public | function | Gets a field item list. | 1 | |
FieldableEntityInterface::getFieldDefinition | public | function | Gets the definition of a contained field. | 1 | |
FieldableEntityInterface::getFieldDefinitions | public | function | Gets an array of field definitions of all contained fields. | 1 | |
FieldableEntityInterface::getFields | public | function | Gets an array of all field item lists. | 1 | |
FieldableEntityInterface::getTranslatableFields | public | function | Gets an array of field item lists for translatable fields. | 1 | |
FieldableEntityInterface::hasField | public | function | Determines whether the entity has a field with the given name. | 1 | |
FieldableEntityInterface::isValidationRequired | public | function | Checks whether entity validation is required before saving the entity. | 1 | |
FieldableEntityInterface::onChange | public | function | Reacts to changes to a field. | 1 | |
FieldableEntityInterface::set | public | function | Sets a field value. | 1 | |
FieldableEntityInterface::setValidationRequired | public | function | Sets whether entity validation is required before saving the entity. | 1 | |
FieldableEntityInterface::toArray | public | function | Gets an array of all field values. | Overrides EntityInterface::toArray | |
FieldableEntityInterface::validate | public | function | Validates the currently set values. | 1 | |
FileInterface::createFileUrl | public | function | Creates a file URL for the URI of this file. | 1 | |
FileInterface::getCreatedTime | public | function | Returns the file entity creation timestamp. | 1 | |
FileInterface::getFilename | public | function | Returns the name of the file. | 1 | |
FileInterface::getFileUri | public | function | Returns the URI of the file. | 1 | |
FileInterface::getMimeType | public | function | Returns the MIME type of the file. | 1 | |
FileInterface::getSize | public | function | Returns the size of the file. | 1 | |
FileInterface::isPermanent | public | function | Returns TRUE if the file is permanent. | 1 | |
FileInterface::isTemporary | public | function | Returns TRUE if the file is temporary. | 1 | |
FileInterface::setFilename | public | function | Sets the name of the file. | 1 | |
FileInterface::setFileUri | public | function | Sets the URI of the file. | 1 | |
FileInterface::setMimeType | public | function | Sets the MIME type of the file. | 1 | |
FileInterface::setPermanent | public | function | Sets the file status to permanent. | 1 | |
FileInterface::setSize | public | function | Sets the size of the file. | 1 | |
FileInterface::setTemporary | public | function | Sets the file status to temporary. | 1 | |
FileInterface::STATUS_PERMANENT | constant | Indicates that the file is permanent and should not be deleted. | |||
RefinableCacheableDependencyInterface::addCacheableDependency | public | function | Adds a dependency on an object: merges its cacheability metadata. | 1 | |
RefinableCacheableDependencyInterface::addCacheContexts | public | function | Adds cache contexts. | 1 | |
RefinableCacheableDependencyInterface::addCacheTags | public | function | Adds cache tags. | 1 | |
RefinableCacheableDependencyInterface::mergeCacheMaxAge | public | function | Merges the maximum age (in seconds) with the existing maximum age. | 1 | |
RevisionableInterface::getLoadedRevisionId | public | function | Gets the loaded Revision ID of the entity. | 1 | |
RevisionableInterface::getRevisionId | public | function | Gets the revision identifier of the entity. | 1 | |
RevisionableInterface::isDefaultRevision | public | function | Checks if this entity is the default revision. | 1 | |
RevisionableInterface::isLatestRevision | public | function | Checks if this entity is the latest revision. | 1 | |
RevisionableInterface::isNewRevision | public | function | Determines whether a new revision should be created on save. | 1 | |
RevisionableInterface::preSaveRevision | public | function | Acts on a revision before it gets saved. | 1 | |
RevisionableInterface::setNewRevision | public | function | Enforces an entity to be saved as a new revision. | 1 | |
RevisionableInterface::updateLoadedRevisionId | public | function | Updates the loaded Revision ID with the revision ID. | 1 | |
RevisionableInterface::wasDefaultRevision | public | function | Checks whether the entity object was a default revision when it was saved. | 1 | |
SynchronizableInterface::isSyncing | public | function | Returns whether this entity is being changed as part of a synchronization. | 1 | |
SynchronizableInterface::setSyncing | public | function | Sets the status of the synchronization flag. | 1 | |
TranslatableInterface::addTranslation | public | function | Adds a new translation to the translatable object. | 1 | |
TranslatableInterface::getTranslation | public | function | Gets a translation of the data. | 1 | |
TranslatableInterface::getTranslationLanguages | public | function | Returns the languages the data is translated to. | 1 | |
TranslatableInterface::getUntranslated | public | function | Returns the translatable object in the language it was created. | 1 | |
TranslatableInterface::hasTranslation | public | function | Checks there is a translation for the given language code. | 1 | |
TranslatableInterface::hasTranslationChanges | public | function | Determines if the current translation of the entity has unsaved changes. | 1 | |
TranslatableInterface::isDefaultTranslation | public | function | Checks whether the translation is the default one. | 1 | |
TranslatableInterface::isNewTranslation | public | function | Checks whether the translation is new. | 1 | |
TranslatableInterface::isTranslatable | public | function | Returns the translation support status. | 1 | |
TranslatableInterface::removeTranslation | public | function | Removes the translation identified by the given language code. | 1 | |
TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly | public | function | Checks if untranslatable fields should affect only the default translation. | 1 | |
TranslatableRevisionableInterface::isLatestTranslationAffectedRevision | public | function | Checks whether this is the latest revision affecting this translation. | 1 | |
TranslatableRevisionableInterface::isRevisionTranslationAffected | public | function | Checks whether the current translation is affected by the current revision. | 1 | |
TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced | public | function | Checks if the revision translation affected flag value has been enforced. | 1 | |
TranslatableRevisionableInterface::setRevisionTranslationAffected | public | function | Marks the current revision translation as affected. | 1 | |
TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced | public | function | Enforces the revision translation affected flag value. | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.