Same name and namespace in other branches
- 8.9.x core/modules/file/src/FileInterface.php \Drupal\file\FileInterface
- 9 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 extends \Drupal\Core\Entity\Traversable; interface \Drupal\Core\Entity\EntityChangedInterface; interface \Drupal\user\EntityOwnerInterface
- interface \Drupal\file\FileInterface
Expanded class hierarchy of FileInterface
All classes that implement FileInterface
Related topics
28 files declare their use of FileInterface
- BaseFileConstraintValidator.php in core/
modules/ file/ src/ Plugin/ Validation/ Constraint/ BaseFileConstraintValidator.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 - editor_test.module in core/
modules/ editor/ tests/ modules/ editor_test/ editor_test.module - Helper module for the Text Editor tests.
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|null
* Name of the file, or NULL if unknown.
*/
public function getFilename();
/**
* Sets the name of the file.
*
* @param string|null $filename
* The file name that corresponds to this file, or NULL if unknown. 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|null
* The URI of the file, e.g. public://directory/file.jpg, or NULL if it has
* not yet been set.
*/
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|null
* The MIME type of the file, e.g. image/jpeg or text/xml, or NULL if it
* could not be determined.
*/
public function getMimeType();
/**
* Sets the MIME type of the file.
*
* @param string|null $mime
* The MIME type of the file, e.g. image/jpeg or text/xml, or NULL if it
* could not be determined.
*/
public function setMimeType($mime);
/**
* Returns the size of the file.
*
* @return int|null
* The size of the file in bytes, or NULL if it could not be determined.
*/
public function getSize();
/**
* Sets the size of the file.
*
* @param int|null $size
* The size of the file in bytes, or NULL if it could not be determined.
*/
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|null
* Creation timestamp of the file entity, or NULL if unknown.
*/
public function getCreatedTime();
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AccessibleInterface:: |
public | function | Checks data value access. | 6 |
CacheableDependencyInterface:: |
public | function | The cache contexts associated with this object. | 12 |
CacheableDependencyInterface:: |
public | function | The maximum age for which this object may be cached. | 12 |
CacheableDependencyInterface:: |
public | function | The cache tags associated with this object. | 12 |
EntityChangedInterface:: |
public | function | Gets the timestamp of the last entity change for the current translation. | |
EntityChangedInterface:: |
public | function | Gets the timestamp of the last entity change across all translations. | |
EntityChangedInterface:: |
public | function | Sets the timestamp of the last entity change for the current translation. | |
EntityInterface:: |
public | function | Gets the bundle of the entity. | 1 |
EntityInterface:: |
public static | function | Constructs a new entity object, without permanently saving it. | 1 |
EntityInterface:: |
public | function | Creates a duplicate of the entity. | 2 |
EntityInterface:: |
public | function | Deletes an entity permanently. | 1 |
EntityInterface:: |
public | function | Enforces an entity to be new. | 1 |
EntityInterface:: |
public | function | Returns the cache tags that should be used to invalidate caches. | 3 |
EntityInterface:: |
public | function | Gets the key that is used to store configuration dependencies. | 1 |
EntityInterface:: |
public | function | Gets the configuration dependency name. | 1 |
EntityInterface:: |
public | function | Gets the configuration target identifier for the entity. | 1 |
EntityInterface:: |
public | function | Gets the entity type definition. | 1 |
EntityInterface:: |
public | function | Gets the ID of the type of the entity. | 1 |
EntityInterface:: |
public | function | Gets the original ID. | 1 |
EntityInterface:: |
public | function | Gets a typed data object for this entity object. | 1 |
EntityInterface:: |
public | function | Indicates if a link template exists for a given key. | 1 |
EntityInterface:: |
public | function | Gets the identifier. | 1 |
EntityInterface:: |
public | function | Determines whether the entity is new. | 1 |
EntityInterface:: |
public | function | Gets the label of the entity. | 3 |
EntityInterface:: |
public | function | Gets the language of the entity. | 1 |
EntityInterface:: |
public static | function | Loads an entity. | 1 |
EntityInterface:: |
public static | function | Loads one or more entities. | 1 |
EntityInterface:: |
public | function | Acts on a created entity before hooks are invoked. | 1 |
EntityInterface:: |
public static | function | Acts on deleted entities before the delete hook is invoked. | 7 |
EntityInterface:: |
public static | function | Acts on loaded entities. | 2 |
EntityInterface:: |
public | function | Acts on a saved entity before the insert or update hook is invoked. | 8 |
EntityInterface:: |
public static | function | Changes the values of an entity before it is created. | 4 |
EntityInterface:: |
public static | function | Acts on entities before they are deleted and before hooks are invoked. | 6 |
EntityInterface:: |
public | function | Acts on an entity before the presave hook is invoked. | 8 |
EntityInterface:: |
public | function | Gets a list of entities referenced by this entity. | 2 |
EntityInterface:: |
public | function | Saves an entity permanently. | 3 |
EntityInterface:: |
public | function | Sets the original ID. | 1 |
EntityInterface:: |
public | function | Generates the HTML for a link to this entity. | 1 |
EntityInterface:: |
public | function | Gets the URL object for the entity. | 1 |
EntityInterface:: |
public | function | Gets a list of URI relationships supported by this entity. | 1 |
EntityInterface:: |
public | function | Gets the entity UUID (Universally Unique Identifier). | 1 |
EntityOwnerInterface:: |
public | function | Returns the entity owner's user entity. | 1 |
EntityOwnerInterface:: |
public | function | Returns the entity owner's user ID. | 1 |
EntityOwnerInterface:: |
public | function | Sets the entity owner's user entity. | 1 |
EntityOwnerInterface:: |
public | function | Sets the entity owner's user ID. | 1 |
FieldableEntityInterface:: |
public static | function | Provides base field definitions for an entity type. | 7 |
FieldableEntityInterface:: |
public static | function | Provides field definitions for a specific bundle. | 2 |
FieldableEntityInterface:: |
public | function | Gets a field item list. | |
FieldableEntityInterface:: |
public | function | Gets the definition of a contained field. | |
FieldableEntityInterface:: |
public | function | Gets an array of field definitions of all contained fields. | |
FieldableEntityInterface:: |
public | function | Gets an array of all field item lists. | |
FieldableEntityInterface:: |
public | function | Gets an array of field item lists for translatable fields. | |
FieldableEntityInterface:: |
public | function | Determines whether the entity has a field with the given name. | |
FieldableEntityInterface:: |
public | function | Checks whether entity validation is required before saving the entity. | |
FieldableEntityInterface:: |
public | function | Reacts to changes to a field. | |
FieldableEntityInterface:: |
public | function | Sets a field value. | |
FieldableEntityInterface:: |
public | function | Sets whether entity validation is required before saving the entity. | |
FieldableEntityInterface:: |
public | function |
Gets an array of all field values. Overrides EntityInterface:: |
|
FieldableEntityInterface:: |
public | function | Validates the currently set values. | 1 |
FileInterface:: |
public | function | Creates a file URL for the URI of this file. | 1 |
FileInterface:: |
public | function | Returns the file entity creation timestamp. | 1 |
FileInterface:: |
public | function | Returns the name of the file. | 1 |
FileInterface:: |
public | function | Returns the URI of the file. | 1 |
FileInterface:: |
public | function | Returns the MIME type of the file. | 1 |
FileInterface:: |
public | function | Returns the size of the file. | 1 |
FileInterface:: |
public | function | Returns TRUE if the file is permanent. | 1 |
FileInterface:: |
public | function | Returns TRUE if the file is temporary. | 1 |
FileInterface:: |
public | function | Sets the name of the file. | 1 |
FileInterface:: |
public | function | Sets the URI of the file. | 1 |
FileInterface:: |
public | function | Sets the MIME type of the file. | 1 |
FileInterface:: |
public | function | Sets the file status to permanent. | 1 |
FileInterface:: |
public | function | Sets the size of the file. | 1 |
FileInterface:: |
public | function | Sets the file status to temporary. | 1 |
FileInterface:: |
constant | Indicates that the file is permanent and should not be deleted. | ||
RefinableCacheableDependencyInterface:: |
public | function | Adds a dependency on an object: merges its cacheability metadata. | |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache contexts. | |
RefinableCacheableDependencyInterface:: |
public | function | Adds cache tags. | |
RefinableCacheableDependencyInterface:: |
public | function | Merges the maximum age (in seconds) with the existing maximum age. | |
RevisionableInterface:: |
public | function | Gets the loaded Revision ID of the entity. | |
RevisionableInterface:: |
public | function | Gets the revision identifier of the entity. | |
RevisionableInterface:: |
public | function | Checks if this entity is the default revision. | |
RevisionableInterface:: |
public | function | Checks if this entity is the latest revision. | |
RevisionableInterface:: |
public | function | Determines whether a new revision should be created on save. | |
RevisionableInterface:: |
public | function | Acts on a revision before it gets saved. | 3 |
RevisionableInterface:: |
public | function | Enforces an entity to be saved as a new revision. | |
RevisionableInterface:: |
public | function | Updates the loaded Revision ID with the revision ID. | |
RevisionableInterface:: |
public | function | Checks whether the entity object was a default revision when it was saved. | |
SynchronizableInterface:: |
public | function | Returns whether this entity is being changed as part of a synchronization. | |
SynchronizableInterface:: |
public | function | Sets the status of the synchronization flag. | |
TranslatableInterface:: |
public | function | Adds a new translation to the translatable object. | |
TranslatableInterface:: |
public | function | Gets a translation of the data. | |
TranslatableInterface:: |
public | function | Returns the languages the data is translated to. | |
TranslatableInterface:: |
public | function | Returns the translatable object in the language it was created. | |
TranslatableInterface:: |
public | function | Checks there is a translation for the given language code. | |
TranslatableInterface:: |
public | function | Determines if the current translation of the entity has unsaved changes. | |
TranslatableInterface:: |
public | function | Checks whether the translation is the default one. | |
TranslatableInterface:: |
public | function | Checks whether the translation is new. | |
TranslatableInterface:: |
public | function | Returns the translation support status. | |
TranslatableInterface:: |
public | function | Removes the translation identified by the given language code. | |
TranslatableRevisionableInterface:: |
public | function | Checks if untranslatable fields should affect only the default translation. | |
TranslatableRevisionableInterface:: |
public | function | Checks whether this is the latest revision affecting this translation. | |
TranslatableRevisionableInterface:: |
public | function | Checks whether the current translation is affected by the current revision. | |
TranslatableRevisionableInterface:: |
public | function | Checks if the revision translation affected flag value has been enforced. | |
TranslatableRevisionableInterface:: |
public | function | Marks the current revision translation as affected. | |
TranslatableRevisionableInterface:: |
public | function | Enforces the revision translation affected flag value. |