class File
Same name in this branch
- 9 core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
- 9 core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
- 9 core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
- 9 core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
- 9 core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
- 9 core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File
Same name in other branches
- 8.9.x core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
- 8.9.x core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
- 8.9.x core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
- 8.9.x core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
- 8.9.x core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
- 8.9.x core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
- 8.9.x core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File
- 10 core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
- 10 core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
- 10 core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
- 10 core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
- 10 core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
- 10 core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
- 10 core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File
- 11.x core/modules/media/src/Plugin/media/Source/File.php \Drupal\media\Plugin\media\Source\File
- 11.x core/modules/file/src/Entity/File.php \Drupal\file\Entity\File
- 11.x core/modules/file/src/Plugin/views/field/File.php \Drupal\file\Plugin\views\field\File
- 11.x core/modules/file/src/Plugin/views/wizard/File.php \Drupal\file\Plugin\views\wizard\File
- 11.x core/modules/file/src/Plugin/migrate/source/d6/File.php \Drupal\file\Plugin\migrate\source\d6\File
- 11.x core/modules/file/src/Plugin/migrate/source/d7/File.php \Drupal\file\Plugin\migrate\source\d7\File
- 11.x core/lib/Drupal/Core/Render/Element/File.php \Drupal\Core\Render\Element\File
Defines the file entity class.
Plugin annotation
@ContentEntityType(
id = "file",
label = @Translation("File"),
label_collection = @Translation("Files"),
label_singular = @Translation("file"),
label_plural = @Translation("files"),
label_count = @PluralTranslation(
singular = "@count file",
plural = "@count files",
),
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",
"owner" = "uid",
}
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\EntityInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Entity\ContentEntityBase extends \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\IteratorAggregate, \Drupal\Core\Entity\ContentEntityInterface, \Drupal\Core\TypedData\TranslationStatusInterface uses \Drupal\Core\Entity\EntityChangesDetectionTrait, \Drupal\Core\Entity\SynchronizableEntityTrait
- class \Drupal\file\Entity\File extends \Drupal\Core\Entity\ContentEntityBase implements \Drupal\file\FileInterface uses \Drupal\Core\Entity\EntityChangedTrait, \Drupal\user\EntityOwnerTrait
- class \Drupal\Core\Entity\ContentEntityBase extends \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\IteratorAggregate, \Drupal\Core\Entity\ContentEntityInterface, \Drupal\Core\TypedData\TranslationStatusInterface uses \Drupal\Core\Entity\EntityChangesDetectionTrait, \Drupal\Core\Entity\SynchronizableEntityTrait
Expanded class hierarchy of File
Related topics
114 files declare their use of File
- AccessTest.php in core/
modules/ file/ tests/ src/ Kernel/ AccessTest.php - CKEditor5ImageController.php in core/
modules/ ckeditor5/ src/ Controller/ CKEditor5ImageController.php - CKEditor5Test.php in core/
modules/ ckeditor5/ tests/ src/ FunctionalJavascript/ CKEditor5Test.php - ContentEntityTest.php in core/
modules/ migrate_drupal/ tests/ src/ Kernel/ Plugin/ migrate/ source/ ContentEntityTest.php - ContentModerationTest.php in core/
modules/ media_library/ tests/ src/ FunctionalJavascript/ ContentModerationTest.php
316 string references to 'File'
- AccessTest::setUp in core/
modules/ file/ tests/ src/ Kernel/ AccessTest.php - AjaxFileManagedMultipleTest::testMultipleFilesUpload in core/
modules/ file/ tests/ src/ FunctionalJavascript/ AjaxFileManagedMultipleTest.php - Tests if managed file form element works well with multiple files upload.
- AnnotatedClassDiscoveryTest::provideBadAnnotations in core/
tests/ Drupal/ Tests/ Component/ Plugin/ Discovery/ AnnotatedClassDiscoveryTest.php - All the Drupal documentation standards tags.
- AssetResolver::getCssAssets in core/
lib/ Drupal/ Core/ Asset/ AssetResolver.php - Returns the CSS assets for the current response's libraries.
- AssetResolver::getJsAssets in core/
lib/ Drupal/ Core/ Asset/ AssetResolver.php - Returns the JavaScript assets for the current response's libraries.
File
-
core/
modules/ file/ src/ Entity/ File.php, line 47
Namespace
Drupal\file\EntityView source
class File extends ContentEntityBase implements FileInterface {
use EntityChangedTrait;
use EntityOwnerTrait;
/**
* {@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 createFileUrl($relative = TRUE) {
/** @var \Drupal\Core\File\FileUrlGeneratorInterface $file_url_generator */
$file_url_generator = \Drupal::service('file_url_generator');
return $relative ? $file_url_generator->generateString($this->getFileUri()) : $file_url_generator->generateAbsoluteString($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 isPermanent() {
return $this->get('status')->value == static::STATUS_PERMANENT;
}
/**
* {@inheritdoc}
*/
public function isTemporary() {
return $this->get('status')->value == 0;
}
/**
* {@inheritdoc}
*/
public function setPermanent() {
$this->get('status')->value = static::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::service('file_system')->basename($values['uri']);
}
// Automatically detect filemime if not set.
if (!isset($values['filemime']) && isset($values['uri'])) {
$guesser = \Drupal::service('file.mime_type.guesser');
if ($guesser instanceof MimeTypeGuesserInterface) {
$values['filemime'] = $guesser->guessMimeType($values['uri']);
}
else {
$values['filemime'] = $guesser->guess($values['uri']);
@trigger_error('\\Symfony\\Component\\HttpFoundation\\File\\MimeType\\MimeTypeGuesserInterface is deprecated in drupal:9.1.0 and is removed from drupal:10.0.0. Implement \\Symfony\\Component\\Mime\\MimeTypeGuesserInterface instead. See https://www.drupal.org/node/3133341', E_USER_DEPRECATED);
}
}
}
/**
* {@inheritdoc}
*/
public function preSave(EntityStorageInterface $storage) {
parent::preSave($storage);
// The file itself might not exist or be available right now.
$uri = $this->getFileUri();
$size = @filesize($uri);
// Set size unless there was an error.
if ($size !== FALSE) {
$this->setSize($size);
}
}
/**
* {@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.
try {
\Drupal::service('file_system')->delete($entity->getFileUri());
} catch (FileException $e) {
// Ignore and continue.
}
}
}
/**
* {@inheritdoc}
*/
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
/** @var \Drupal\Core\Field\BaseFieldDefinition[] $fields */
$fields = parent::baseFieldDefinitions($entity_type);
$fields += static::ownerBaseFieldDefinitions($entity_type);
$fields['fid']->setLabel(t('File ID'))
->setDescription(t('The file ID.'));
$fields['uuid']->setDescription(t('The file UUID.'));
$fields['langcode']->setLabel(t('Language code'))
->setDescription(t('The file language code.'));
$fields['uid']->setDescription(t('The user ID of the file.'));
$fields['filename'] = BaseFieldDefinition::create('string')->setLabel(t('Filename'))
->setDescription(t('Name of the file with no path components.'));
$fields['uri'] = BaseFieldDefinition::create('file_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;
}
/**
* {@inheritdoc}
*/
public static function getDefaultEntityOwner() {
return NULL;
}
/**
* {@inheritdoc}
*/
protected function invalidateTagsOnSave($update) {
$tags = $this->getListCacheTagsToInvalidate();
// Always invalidate the 404 or 403 response cache because while files do
// not have a canonical URL as such, they may be served via routes such as
// private files.
// Creating or updating an entity may change a cached 403 or 404 response.
$tags = Cache::mergeTags($tags, [
'4xx-response',
]);
if ($update) {
$tags = Cache::mergeTags($tags, $this->getCacheTagsToInvalidate());
}
Cache::invalidateTags($tags);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
---|---|---|---|---|---|---|
CacheableDependencyTrait::$cacheContexts | protected | property | Cache contexts. | |||
CacheableDependencyTrait::$cacheMaxAge | protected | property | Cache max-age. | |||
CacheableDependencyTrait::$cacheTags | protected | property | Cache tags. | |||
CacheableDependencyTrait::setCacheability | protected | function | Sets cacheability; useful for value object constructors. | |||
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::$enforceRevisionTranslationAffected | protected | property | Whether the revision translation affected flag has been enforced. | |||
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::$fieldsToSkipFromTranslationChangesCheck | protected static | property | Local cache for fields to skip from the checking for translation changes. | |||
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::$loadedRevisionId | protected | property | The loaded revision ID before the new revision was set. | |||
ContentEntityBase::$newRevision | protected | property | Boolean indicating whether a new revision should be created on save. | |||
ContentEntityBase::$revisionTranslationAffectedKey | protected | property | The revision translation affected entity key. | |||
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 EntityBase::access | 1 | |
ContentEntityBase::addTranslation | public | function | ||||
ContentEntityBase::bundle | public | function | Gets the bundle of the entity. | Overrides EntityBase::bundle | ||
ContentEntityBase::bundleFieldDefinitions | public static | function | 4 | |||
ContentEntityBase::clearTranslationCache | protected | function | Clear entity translation object cache to remove stale references. | |||
ContentEntityBase::create | public static | function | Constructs a new entity object, without permanently saving it. | Overrides EntityBase::create | ||
ContentEntityBase::createDuplicate | public | function | Creates a duplicate of the entity. | Overrides EntityBase::createDuplicate | 1 | |
ContentEntityBase::get | public | function | ||||
ContentEntityBase::getEntityKey | protected | function | Gets the value of the given entity key, if defined. | 1 | ||
ContentEntityBase::getFieldDefinition | public | function | ||||
ContentEntityBase::getFieldDefinitions | public | function | ||||
ContentEntityBase::getFields | public | function | ||||
ContentEntityBase::getFieldsToSkipFromTranslationChangesCheck | protected | function | Returns an array of field names to skip in ::hasTranslationChanges. | 1 | ||
ContentEntityBase::getIterator | public | function | ||||
ContentEntityBase::getLanguages | protected | function | ||||
ContentEntityBase::getLoadedRevisionId | public | function | ||||
ContentEntityBase::getRevisionId | public | function | ||||
ContentEntityBase::getTranslatableFields | public | function | ||||
ContentEntityBase::getTranslatedField | protected | function | Gets a translated field. | |||
ContentEntityBase::getTranslation | public | function | ||||
ContentEntityBase::getTranslationLanguages | public | function | ||||
ContentEntityBase::getTranslationStatus | public | function | Returns the translation status. | Overrides TranslationStatusInterface::getTranslationStatus | ||
ContentEntityBase::getUntranslated | public | function | ||||
ContentEntityBase::hasField | public | function | ||||
ContentEntityBase::hasTranslation | public | function | ||||
ContentEntityBase::hasTranslationChanges | public | function | ||||
ContentEntityBase::id | public | function | Gets the identifier. | Overrides EntityBase::id | ||
ContentEntityBase::initializeTranslation | protected | function | Instantiates a translation object for an existing translation. | |||
ContentEntityBase::isDefaultRevision | public | function | ||||
ContentEntityBase::isDefaultTranslation | public | function | ||||
ContentEntityBase::isDefaultTranslationAffectedOnly | public | function | ||||
ContentEntityBase::isLatestRevision | public | function | ||||
ContentEntityBase::isLatestTranslationAffectedRevision | public | function | ||||
ContentEntityBase::isNewRevision | public | function | ||||
ContentEntityBase::isNewTranslation | public | function | ||||
ContentEntityBase::isRevisionTranslationAffected | public | function | ||||
ContentEntityBase::isRevisionTranslationAffectedEnforced | public | function | ||||
ContentEntityBase::isTranslatable | public | function | ||||
ContentEntityBase::isValidationRequired | public | function | ||||
ContentEntityBase::label | public | function | Gets the label of the entity. | Overrides EntityBase::label | 6 | |
ContentEntityBase::language | public | function | Gets the language of the entity. | Overrides EntityBase::language | ||
ContentEntityBase::onChange | public | function | ||||
ContentEntityBase::postCreate | public | function | Acts on a created entity before hooks are invoked. | Overrides EntityBase::postCreate | 1 | |
ContentEntityBase::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. | Overrides EntityBase::postSave | 9 | |
ContentEntityBase::preSaveRevision | public | function | 3 | |||
ContentEntityBase::referencedEntities | public | function | Gets a list of entities referenced by this entity. | Overrides EntityBase::referencedEntities | 1 | |
ContentEntityBase::removeTranslation | public | function | ||||
ContentEntityBase::set | public | function | ||||
ContentEntityBase::setDefaultLangcode | protected | function | Populates the local cache for the default language code. | |||
ContentEntityBase::setNewRevision | public | function | ||||
ContentEntityBase::setRevisionTranslationAffected | public | function | ||||
ContentEntityBase::setRevisionTranslationAffectedEnforced | public | function | ||||
ContentEntityBase::setValidationRequired | public | function | ||||
ContentEntityBase::toArray | public | function | Gets an array of all property values. | Overrides EntityBase::toArray | ||
ContentEntityBase::updateFieldLangcodes | protected | function | Updates language for already instantiated fields. | |||
ContentEntityBase::updateLoadedRevisionId | public | function | ||||
ContentEntityBase::updateOriginalValues | public | function | Updates the original values with the interim changes. | |||
ContentEntityBase::uuid | public | function | Gets the entity UUID (Universally Unique Identifier). | Overrides EntityBase::uuid | ||
ContentEntityBase::validate | public | function | 1 | |||
ContentEntityBase::wasDefaultRevision | public | function | ||||
ContentEntityBase::__clone | public | function | Magic method: Implements a deep clone. | |||
ContentEntityBase::__construct | public | function | Constructs an Entity object. | Overrides EntityBase::__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 EntityBase::__sleep | |||
ContentEntityBase::__unset | public | function | Implements the magic method for unset(). | |||
DependencySerializationTrait::$_entityStorages | protected | property | ||||
DependencySerializationTrait::$_serviceIds | protected | property | ||||
DependencySerializationTrait::__sleep | public | function | Aliased as: traitSleep | 1 | ||
DependencySerializationTrait::__wakeup | public | function | 2 | |||
EntityBase::$enforceIsNew | protected | property | Boolean indicating whether the entity should be forced to be new. | |||
EntityBase::$entityTypeId | protected | property | The entity type. | |||
EntityBase::$typedData | protected | property | A typed data object wrapping this entity. | |||
EntityBase::delete | public | function | Deletes an entity permanently. | Overrides EntityInterface::delete | 1 | |
EntityBase::enforceIsNew | public | function | Enforces an entity to be new. | Overrides EntityInterface::enforceIsNew | ||
EntityBase::entityTypeBundleInfo | protected | function | Gets the entity type bundle info service. | |||
EntityBase::entityTypeManager | protected | function | Gets the entity type manager. | |||
EntityBase::getCacheContexts | public | function | The cache contexts associated with this object. | Overrides CacheableDependencyTrait::getCacheContexts | ||
EntityBase::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | Overrides CacheableDependencyTrait::getCacheMaxAge | ||
EntityBase::getCacheTags | public | function | The cache tags associated with this object. | Overrides CacheableDependencyTrait::getCacheTags | ||
EntityBase::getCacheTagsToInvalidate | public | function | Returns the cache tags that should be used to invalidate caches. | Overrides EntityInterface::getCacheTagsToInvalidate | 4 | |
EntityBase::getConfigDependencyKey | public | function | Gets the key that is used to store configuration dependencies. | Overrides EntityInterface::getConfigDependencyKey | ||
EntityBase::getConfigDependencyName | public | function | Gets the configuration dependency name. | Overrides EntityInterface::getConfigDependencyName | 1 | |
EntityBase::getConfigTarget | public | function | Gets the configuration target identifier for the entity. | Overrides EntityInterface::getConfigTarget | 1 | |
EntityBase::getEntityType | public | function | Gets the entity type definition. | Overrides EntityInterface::getEntityType | ||
EntityBase::getEntityTypeId | public | function | Gets the ID of the type of the entity. | Overrides EntityInterface::getEntityTypeId | ||
EntityBase::getListCacheTagsToInvalidate | protected | function | The list cache tags to invalidate for this entity. | |||
EntityBase::getOriginalId | public | function | Gets the original ID. | Overrides EntityInterface::getOriginalId | 1 | |
EntityBase::getTypedData | public | function | Gets a typed data object for this entity object. | Overrides EntityInterface::getTypedData | ||
EntityBase::getTypedDataClass | private | function | Returns the typed data class name for this entity. | |||
EntityBase::hasLinkTemplate | public | function | Indicates if a link template exists for a given key. | Overrides EntityInterface::hasLinkTemplate | ||
EntityBase::invalidateTagsOnDelete | protected static | function | Invalidates an entity's cache tags upon delete. | 1 | ||
EntityBase::isNew | public | function | Determines whether the entity is new. | Overrides EntityInterface::isNew | 2 | |
EntityBase::languageManager | protected | function | Gets the language manager. | |||
EntityBase::linkTemplates | protected | function | Gets an array link templates. | 1 | ||
EntityBase::load | public static | function | Loads an entity. | Overrides EntityInterface::load | ||
EntityBase::loadMultiple | public static | function | Loads one or more entities. | Overrides EntityInterface::loadMultiple | ||
EntityBase::postDelete | public static | function | Acts on deleted entities before the delete hook is invoked. | Overrides EntityInterface::postDelete | 19 | |
EntityBase::postLoad | public static | function | Acts on loaded entities. | Overrides EntityInterface::postLoad | 3 | |
EntityBase::save | public | function | Saves an entity permanently. | Overrides EntityInterface::save | 3 | |
EntityBase::setOriginalId | public | function | Sets the original ID. | Overrides EntityInterface::setOriginalId | 1 | |
EntityBase::toLink | public | function | Generates the HTML for a link to this entity. | Overrides EntityInterface::toLink | ||
EntityBase::toUrl | public | function | Gets the URL object for the entity. | Overrides EntityInterface::toUrl | 2 | |
EntityBase::uriRelationships | public | function | Gets a list of URI relationships supported by this entity. | Overrides EntityInterface::uriRelationships | ||
EntityBase::urlRouteParameters | protected | function | Gets an array of placeholders for this entity. | 2 | ||
EntityBase::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. | |||
EntityChangesDetectionTrait::getFieldsToSkipFromTranslationChangesCheck | protected | function | Returns an array of field names to skip when checking for changes. | Aliased as: traitGetFieldsToSkipFromTranslationChangesCheck | ||
EntityOwnerTrait::getOwner | public | function | 1 | |||
EntityOwnerTrait::getOwnerId | public | function | ||||
EntityOwnerTrait::ownerBaseFieldDefinitions | public static | function | Returns an array of base field definitions for entity owners. | |||
EntityOwnerTrait::setOwner | public | function | ||||
EntityOwnerTrait::setOwnerId | public | function | ||||
File::baseFieldDefinitions | public static | function | Overrides ContentEntityBase::baseFieldDefinitions | |||
File::createFileUrl | public | function | Creates a file URL for the URI of this file. | Overrides FileInterface::createFileUrl | ||
File::getCreatedTime | public | function | Returns the file entity creation timestamp. | Overrides FileInterface::getCreatedTime | ||
File::getDefaultEntityOwner | public static | function | Default value callback for 'owner' base field. | Overrides EntityOwnerTrait::getDefaultEntityOwner | ||
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::getSize | public | function | Returns the size of the file. | Overrides FileInterface::getSize | ||
File::invalidateTagsOnSave | protected | function | Invalidates an entity's cache tags upon save. | Overrides EntityBase::invalidateTagsOnSave | ||
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 EntityBase::preCreate | ||
File::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. | Overrides EntityBase::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::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 | ||
FileInterface::STATUS_PERMANENT | constant | Indicates that the file is permanent and should not be deleted. | ||||
RefinableCacheableDependencyTrait::addCacheableDependency | public | function | 1 | |||
RefinableCacheableDependencyTrait::addCacheContexts | public | function | ||||
RefinableCacheableDependencyTrait::addCacheTags | public | function | ||||
RefinableCacheableDependencyTrait::mergeCacheMaxAge | public | function | ||||
SynchronizableEntityTrait::$isSyncing | protected | property | Is entity being created updated or deleted through synchronization process. | |||
SynchronizableEntityTrait::isSyncing | public | function | ||||
SynchronizableEntityTrait::setSyncing | public | function | ||||
TranslationStatusInterface::TRANSLATION_CREATED | constant | Status code identifying a newly created translation. | ||||
TranslationStatusInterface::TRANSLATION_EXISTING | constant | Status code identifying an existing translation. | ||||
TranslationStatusInterface::TRANSLATION_REMOVED | constant | Status code identifying a removed translation. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.