class Media
Same name in this branch
- 8.9.x core/modules/media/src/Plugin/views/wizard/Media.php \Drupal\media\Plugin\views\wizard\Media
Same name in other branches
- 9 core/modules/media/src/Entity/Media.php \Drupal\media\Entity\Media
- 9 core/modules/media/src/Plugin/views/wizard/Media.php \Drupal\media\Plugin\views\wizard\Media
- 9 core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Media.php \Drupal\ckeditor5\Plugin\CKEditor5Plugin\Media
- 10 core/modules/media/src/Entity/Media.php \Drupal\media\Entity\Media
- 10 core/modules/media/src/Plugin/views/wizard/Media.php \Drupal\media\Plugin\views\wizard\Media
- 10 core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Media.php \Drupal\ckeditor5\Plugin\CKEditor5Plugin\Media
- 11.x core/modules/media/src/Entity/Media.php \Drupal\media\Entity\Media
- 11.x core/modules/media/src/Plugin/views/wizard/Media.php \Drupal\media\Plugin\views\wizard\Media
- 11.x core/modules/ckeditor5/src/Plugin/CKEditor5Plugin/Media.php \Drupal\ckeditor5\Plugin\CKEditor5Plugin\Media
Defines the media entity class.
@todo Remove default/fallback entity form operation when #2006348 is done.
Plugin annotation
@ContentEntityType(
id = "media",
label = @Translation("Media"),
label_singular = @Translation("media item"),
label_plural = @Translation("media items"),
label_count = @PluralTranslation(
singular = "@count media item",
plural = "@count media items"
),
bundle_label = @Translation("Media type"),
handlers = {
"storage" = "Drupal\media\MediaStorage",
"view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
"list_builder" = "Drupal\media\MediaListBuilder",
"access" = "Drupal\media\MediaAccessControlHandler",
"form" = {
"default" = "Drupal\media\MediaForm",
"add" = "Drupal\media\MediaForm",
"edit" = "Drupal\media\MediaForm",
"delete" = "Drupal\Core\Entity\ContentEntityDeleteForm",
"delete-multiple-confirm" = "Drupal\Core\Entity\Form\DeleteMultipleForm",
},
"views_data" = "Drupal\media\MediaViewsData",
"route_provider" = {
"html" = "Drupal\media\Routing\MediaRouteProvider",
}
},
base_table = "media",
data_table = "media_field_data",
revision_table = "media_revision",
revision_data_table = "media_field_revision",
translatable = TRUE,
show_revision_ui = TRUE,
entity_keys = {
"id" = "mid",
"revision" = "vid",
"bundle" = "bundle",
"label" = "name",
"langcode" = "langcode",
"uuid" = "uuid",
"published" = "status",
"owner" = "uid",
},
revision_metadata_keys = {
"revision_user" = "revision_user",
"revision_created" = "revision_created",
"revision_log_message" = "revision_log_message",
},
bundle_entity_type = "media_type",
permission_granularity = "bundle",
admin_permission = "administer media",
field_ui_base_route = "entity.media_type.edit_form",
common_reference_target = TRUE,
links = {
"add-page" = "/media/add",
"add-form" = "/media/add/{media_type}",
"canonical" = "/media/{media}/edit",
"collection" = "/admin/content/media",
"delete-form" = "/media/{media}/delete",
"delete-multiple-form" = "/media/delete",
"edit-form" = "/media/{media}/edit",
"revision" = "/media/{media}/revisions/{media_revision}/view",
}
)
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\Core\Entity\EditorialContentEntityBase extends \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\EntityChangedInterface, \Drupal\Core\Entity\EntityPublishedInterface, \Drupal\Core\Entity\RevisionLogInterface uses \Drupal\Core\Entity\EntityChangedTrait, \Drupal\Core\Entity\EntityPublishedTrait, \Drupal\Core\Entity\RevisionLogEntityTrait
- class \Drupal\media\Entity\Media extends \Drupal\Core\Entity\EditorialContentEntityBase implements \Drupal\media\MediaInterface uses \Drupal\user\EntityOwnerTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\Core\Entity\EditorialContentEntityBase extends \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\EntityChangedInterface, \Drupal\Core\Entity\EntityPublishedInterface, \Drupal\Core\Entity\RevisionLogInterface uses \Drupal\Core\Entity\EntityChangedTrait, \Drupal\Core\Entity\EntityPublishedTrait, \Drupal\Core\Entity\RevisionLogEntityTrait
- 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 Media
See also
https://www.drupal.org/node/2006348.
37 files declare their use of Media
- CKEditorIntegrationTest.php in core/
modules/ media_library/ tests/ src/ FunctionalJavascript/ CKEditorIntegrationTest.php - CKEditorIntegrationTest.php in core/
modules/ media/ tests/ src/ FunctionalJavascript/ CKEditorIntegrationTest.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 - EditorMediaDialogTest.php in core/
modules/ media/ tests/ src/ Kernel/ EditorMediaDialogTest.php
263 string references to 'Media'
- AddFormBase::buildEntityFormElement in core/
modules/ media_library/ src/ Form/ AddFormBase.php - Builds the sub-form for setting required fields on a new media item.
- AddFormBase::getAddedMediaItems in core/
modules/ media_library/ src/ Form/ AddFormBase.php - Get all added media items from the form state.
- AddFormBase::processInputValues in core/
modules/ media_library/ src/ Form/ AddFormBase.php - Creates media items from source field input values.
- AddFormBase::removeButtonSubmit in core/
modules/ media_library/ src/ Form/ AddFormBase.php - Submit handler for the remove button.
- AddFormBase::updateFormCallback in core/
modules/ media_library/ src/ Form/ AddFormBase.php - AJAX callback to update the entire form based on source field input.
File
-
core/
modules/ media/ src/ Entity/ Media.php, line 86
Namespace
Drupal\media\EntityView source
class Media extends EditorialContentEntityBase implements MediaInterface {
use EntityOwnerTrait;
use StringTranslationTrait;
/**
* {@inheritdoc}
*/
public function getName() {
$name = $this->getEntityKey('label');
if (empty($name)) {
$media_source = $this->getSource();
return $media_source->getMetadata($this, $media_source->getPluginDefinition()['default_name_metadata_attribute']);
}
return $name;
}
/**
* {@inheritdoc}
*/
public function label() {
return $this->getName();
}
/**
* {@inheritdoc}
*/
public function setName($name) {
return $this->set('name', $name);
}
/**
* {@inheritdoc}
*/
public function getCreatedTime() {
return $this->get('created')->value;
}
/**
* {@inheritdoc}
*/
public function setCreatedTime($timestamp) {
return $this->set('created', $timestamp);
}
/**
* {@inheritdoc}
*/
public function getSource() {
return $this->bundle->entity
->getSource();
}
/**
* Update the thumbnail for the media item.
*
* @param bool $from_queue
* Specifies whether the thumbnail update is triggered from the queue.
*
* @return \Drupal\media\MediaInterface
* The updated media item.
*
* @internal
*
* @todo There has been some disagreement about how to handle updates to
* thumbnails. We need to decide on what the API will be for this.
* https://www.drupal.org/node/2878119
*/
protected function updateThumbnail($from_queue = FALSE) {
$this->thumbnail->target_id = $this->loadThumbnail($this->getThumbnailUri($from_queue))
->id();
// Set the thumbnail alt.
$media_source = $this->getSource();
$plugin_definition = $media_source->getPluginDefinition();
$this->thumbnail->alt = '';
if (!empty($plugin_definition['thumbnail_alt_metadata_attribute'])) {
$this->thumbnail->alt = $media_source->getMetadata($this, $plugin_definition['thumbnail_alt_metadata_attribute']);
}
return $this;
}
/**
* Loads the file entity for the thumbnail.
*
* If the file entity does not exist, it will be created.
*
* @param string $thumbnail_uri
* (optional) The URI of the thumbnail, used to load or create the file
* entity. If omitted, the default thumbnail URI will be used.
*
* @return \Drupal\file\FileInterface
* The thumbnail file entity.
*/
protected function loadThumbnail($thumbnail_uri = NULL) {
$values = [
'uri' => $thumbnail_uri ?: $this->getDefaultThumbnailUri(),
];
$file_storage = $this->entityTypeManager()
->getStorage('file');
$existing = $file_storage->loadByProperties($values);
if ($existing) {
$file = reset($existing);
}
else {
/** @var \Drupal\file\FileInterface $file */
$file = $file_storage->create($values);
if ($owner = $this->getOwner()) {
$file->setOwner($owner);
}
$file->setPermanent();
$file->save();
}
return $file;
}
/**
* Returns the URI of the default thumbnail.
*
* @return string
* The default thumbnail URI.
*/
protected function getDefaultThumbnailUri() {
$default_thumbnail_filename = $this->getSource()
->getPluginDefinition()['default_thumbnail_filename'];
return \Drupal::config('media.settings')->get('icon_base_uri') . '/' . $default_thumbnail_filename;
}
/**
* Updates the queued thumbnail for the media item.
*
* @return \Drupal\media\MediaInterface
* The updated media item.
*
* @internal
*
* @todo If the need arises in contrib, consider making this a public API,
* by adding an interface that extends MediaInterface.
*/
public function updateQueuedThumbnail() {
$this->updateThumbnail(TRUE);
return $this;
}
/**
* Gets the URI for the thumbnail of a media item.
*
* If thumbnail fetching is queued, new media items will use the default
* thumbnail, and existing media items will use the current thumbnail, until
* the queue is processed and the updated thumbnail has been fetched.
* Otherwise, the new thumbnail will be fetched immediately.
*
* @param bool $from_queue
* Specifies whether the thumbnail is being fetched from the queue.
*
* @return string
* The file URI for the thumbnail of the media item.
*
* @internal
*/
protected function getThumbnailUri($from_queue) {
$thumbnails_queued = $this->bundle->entity
->thumbnailDownloadsAreQueued();
if ($thumbnails_queued && $this->isNew()) {
return $this->getDefaultThumbnailUri();
}
elseif ($thumbnails_queued && !$from_queue) {
return $this->get('thumbnail')->entity
->getFileUri();
}
$source = $this->getSource();
return $source->getMetadata($this, $source->getPluginDefinition()['thumbnail_uri_metadata_attribute']);
}
/**
* Determines if the source field value has changed.
*
* @return bool
* TRUE if the source field value changed, FALSE otherwise.
*
* @internal
*/
protected function hasSourceFieldChanged() {
$source_field_name = $this->getSource()
->getConfiguration()['source_field'];
$current_items = $this->get($source_field_name);
return isset($this->original) && !$current_items->equals($this->original
->get($source_field_name));
}
/**
* Determines if the thumbnail should be updated for a media item.
*
* @param bool $is_new
* Specifies whether the media item is new.
*
* @return bool
* TRUE if the thumbnail should be updated, FALSE otherwise.
*/
protected function shouldUpdateThumbnail($is_new = FALSE) {
// Update thumbnail if we don't have a thumbnail yet or when the source
// field value changes.
return !$this->get('thumbnail')->entity || $is_new || $this->hasSourceFieldChanged();
}
/**
* {@inheritdoc}
*/
public function preSave(EntityStorageInterface $storage) {
parent::preSave($storage);
// If no thumbnail has been explicitly set, use the default thumbnail.
if ($this->get('thumbnail')
->isEmpty()) {
$this->thumbnail->target_id = $this->loadThumbnail()
->id();
}
}
/**
* {@inheritdoc}
*/
public function postSave(EntityStorageInterface $storage, $update = TRUE) {
parent::postSave($storage, $update);
$is_new = !$update;
foreach ($this->translations as $langcode => $data) {
if ($this->hasTranslation($langcode)) {
$translation = $this->getTranslation($langcode);
if ($translation->bundle->entity
->thumbnailDownloadsAreQueued() && $translation->shouldUpdateThumbnail($is_new)) {
\Drupal::queue('media_entity_thumbnail')->createItem([
'id' => $translation->id(),
]);
}
}
}
}
/**
* {@inheritdoc}
*/
public function preSaveRevision(EntityStorageInterface $storage, \stdClass $record) {
parent::preSaveRevision($storage, $record);
$is_new_revision = $this->isNewRevision();
if (!$is_new_revision && isset($this->original) && empty($record->revision_log_message)) {
// If we are updating an existing media item without adding a
// new revision, we need to make sure $entity->revision_log_message is
// reset whenever it is empty.
// Therefore, this code allows us to avoid clobbering an existing log
// entry with an empty one.
$record->revision_log_message = $this->original->revision_log_message->value;
}
if ($is_new_revision) {
$record->revision_created = self::getRequestTime();
}
}
/**
* Sets the media entity's field values from the source's metadata.
*
* Fetching the metadata could be slow (e.g., if requesting it from a remote
* API), so this is called by \Drupal\media\MediaStorage::save() prior to it
* beginning the database transaction, whereas static::preSave() executes
* after the transaction has already started.
*
* @internal
* Expose this as an API in
* https://www.drupal.org/project/drupal/issues/2992426.
*/
public function prepareSave() {
// @todo If the source plugin talks to a remote API (e.g. oEmbed), this code
// might be performing a fair number of HTTP requests. This is dangerously
// brittle and should probably be handled by a queue, to avoid doing HTTP
// operations during entity save. See
// https://www.drupal.org/project/drupal/issues/2976875 for more.
// In order for metadata to be mapped correctly, $this->original must be
// set. However, that is only set once parent::save() is called, so work
// around that by setting it here.
if (!isset($this->original) && ($id = $this->id())) {
$this->original = $this->entityTypeManager()
->getStorage('media')
->loadUnchanged($id);
}
$media_source = $this->getSource();
foreach ($this->translations as $langcode => $data) {
if ($this->hasTranslation($langcode)) {
$translation = $this->getTranslation($langcode);
// Try to set fields provided by the media source and mapped in
// media type config.
foreach ($translation->bundle->entity
->getFieldMap() as $metadata_attribute_name => $entity_field_name) {
// Only save value in entity field if empty. Do not overwrite existing
// data.
if ($translation->hasField($entity_field_name) && ($translation->get($entity_field_name)
->isEmpty() || $translation->hasSourceFieldChanged())) {
$translation->set($entity_field_name, $media_source->getMetadata($translation, $metadata_attribute_name));
}
}
// Try to set a default name for this media item if no name is provided.
if ($translation->get('name')
->isEmpty()) {
$translation->setName($translation->getName());
}
// Set thumbnail.
if ($translation->shouldUpdateThumbnail($this->isNew())) {
$translation->updateThumbnail();
}
}
}
}
/**
* {@inheritdoc}
*/
public function validate() {
$media_source = $this->getSource();
if ($media_source instanceof MediaSourceEntityConstraintsInterface) {
$entity_constraints = $media_source->getEntityConstraints();
$this->getTypedData()
->getDataDefinition()
->setConstraints($entity_constraints);
}
if ($media_source instanceof MediaSourceFieldConstraintsInterface) {
$source_field_name = $media_source->getConfiguration()['source_field'];
$source_field_constraints = $media_source->getSourceFieldConstraints();
$this->get($source_field_name)
->getDataDefinition()
->setConstraints($source_field_constraints);
}
return parent::validate();
}
/**
* {@inheritdoc}
*/
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
$fields = parent::baseFieldDefinitions($entity_type);
$fields += static::ownerBaseFieldDefinitions($entity_type);
$fields['name'] = BaseFieldDefinition::create('string')->setLabel(t('Name'))
->setRequired(TRUE)
->setTranslatable(TRUE)
->setRevisionable(TRUE)
->setDefaultValue('')
->setSetting('max_length', 255)
->setDisplayOptions('form', [
'type' => 'string_textfield',
'weight' => -5,
])
->setDisplayConfigurable('form', TRUE)
->setDisplayConfigurable('view', TRUE);
$fields['thumbnail'] = BaseFieldDefinition::create('image')->setLabel(t('Thumbnail'))
->setDescription(t('The thumbnail of the media item.'))
->setRevisionable(TRUE)
->setTranslatable(TRUE)
->setDisplayOptions('view', [
'type' => 'image',
'weight' => 5,
'label' => 'hidden',
'settings' => [
'image_style' => 'thumbnail',
],
])
->setDisplayConfigurable('view', TRUE)
->setReadOnly(TRUE);
$fields['uid']->setLabel(t('Authored by'))
->setDescription(t('The user ID of the author.'))
->setRevisionable(TRUE)
->setDisplayOptions('form', [
'type' => 'entity_reference_autocomplete',
'weight' => 5,
'settings' => [
'match_operator' => 'CONTAINS',
'size' => '60',
'autocomplete_type' => 'tags',
'placeholder' => '',
],
])
->setDisplayConfigurable('form', TRUE)
->setDisplayOptions('view', [
'label' => 'hidden',
'type' => 'author',
'weight' => 0,
])
->setDisplayConfigurable('view', TRUE);
$fields['status']->setDisplayOptions('form', [
'type' => 'boolean_checkbox',
'settings' => [
'display_label' => TRUE,
],
'weight' => 100,
])
->setDisplayConfigurable('form', TRUE);
$fields['created'] = BaseFieldDefinition::create('created')->setLabel(t('Authored on'))
->setDescription(t('The time the media item was created.'))
->setTranslatable(TRUE)
->setRevisionable(TRUE)
->setDefaultValueCallback(static::class . '::getRequestTime')
->setDisplayOptions('form', [
'type' => 'datetime_timestamp',
'weight' => 10,
])
->setDisplayConfigurable('form', TRUE)
->setDisplayOptions('view', [
'label' => 'hidden',
'type' => 'timestamp',
'weight' => 0,
])
->setDisplayConfigurable('view', TRUE);
$fields['changed'] = BaseFieldDefinition::create('changed')->setLabel(t('Changed'))
->setDescription(t('The time the media item was last edited.'))
->setTranslatable(TRUE)
->setRevisionable(TRUE);
return $fields;
}
/**
* Default value callback for 'uid' base field definition.
*
* @see ::baseFieldDefinitions()
*
* @deprecated The ::getCurrentUserId method is deprecated in 8.6.x and will
* be removed before 9.0.0.
*
* @return int[]
* An array of default values.
*/
public static function getCurrentUserId() {
@trigger_error('The ::getCurrentUserId method is deprecated in 8.6.x and will be removed before 9.0.0.', E_USER_DEPRECATED);
return [
\Drupal::currentUser()->id(),
];
}
/**
* {@inheritdoc}
*/
public static function getRequestTime() {
return \Drupal::time()->getRequestTime();
}
}
Members
Title Sort descending | Deprecated | 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::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::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 | |||
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::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 | An array of entity type IDs keyed by the property name of their storages. | ||||
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 | ||||
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::create | public static | function | Constructs a new entity object, without permanently saving it. | Overrides EntityInterface::create | |||
EntityBase::delete | public | function | Deletes an entity permanently. | Overrides EntityInterface::delete | 2 | ||
EntityBase::enforceIsNew | public | function | Enforces an entity to be new. | Overrides EntityInterface::enforceIsNew | |||
EntityBase::entityManager | Deprecated | protected | function | Gets the entity manager. | |||
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::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::invalidateTagsOnSave | protected | function | Invalidates an entity's cache tags upon save. | 1 | |||
EntityBase::isNew | public | function | Determines whether the entity is new. | Overrides EntityInterface::isNew | 2 | ||
EntityBase::languageManager | protected | function | Gets the language manager. | ||||
EntityBase::link | public | function | Deprecated way of generating a link to the entity. See toLink(). | Overrides EntityInterface::link | 1 | ||
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 | 18 | ||
EntityBase::postLoad | public static | function | Acts on loaded entities. | Overrides EntityInterface::postLoad | 2 | ||
EntityBase::preCreate | public static | function | Changes the values of an entity before it is created. | Overrides EntityInterface::preCreate | 7 | ||
EntityBase::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. | Overrides EntityInterface::preDelete | 6 | ||
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::url | public | function | Gets the public URL for this entity. | Overrides EntityInterface::url | 2 | ||
EntityBase::urlInfo | public | function | Gets the URL object for the entity. | Overrides EntityInterface::urlInfo | 1 | ||
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::getDefaultEntityOwner | public static | function | Default value callback for 'owner' base field. | 1 | |||
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 | |||||
EntityPublishedTrait::isPublished | public | function | |||||
EntityPublishedTrait::publishedBaseFieldDefinitions | public static | function | Returns an array of base field definitions for publishing status. | ||||
EntityPublishedTrait::setPublished | public | function | |||||
EntityPublishedTrait::setUnpublished | public | function | |||||
Media::baseFieldDefinitions | public static | function | Overrides EditorialContentEntityBase::baseFieldDefinitions | ||||
Media::getCreatedTime | public | function | Returns the media item creation timestamp. | Overrides MediaInterface::getCreatedTime | |||
Media::getCurrentUserId | Deprecated | public static | function | Default value callback for 'uid' base field definition. | |||
Media::getDefaultThumbnailUri | protected | function | Returns the URI of the default thumbnail. | ||||
Media::getName | public | function | Gets the media item name. | Overrides MediaInterface::getName | |||
Media::getRequestTime | public static | function | |||||
Media::getSource | public | function | Returns the media source. | Overrides MediaInterface::getSource | |||
Media::getThumbnailUri | protected | function | Gets the URI for the thumbnail of a media item. | ||||
Media::hasSourceFieldChanged | protected | function | Determines if the source field value has changed. | ||||
Media::label | public | function | Gets the label of the entity. | Overrides ContentEntityBase::label | |||
Media::loadThumbnail | protected | function | Loads the file entity for the thumbnail. | ||||
Media::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. | Overrides ContentEntityBase::postSave | |||
Media::prepareSave | public | function | Sets the media entity's field values from the source's metadata. | ||||
Media::preSave | public | function | Acts on an entity before the presave hook is invoked. | Overrides ContentEntityBase::preSave | |||
Media::preSaveRevision | public | function | Acts on a revision before it gets saved. | Overrides ContentEntityBase::preSaveRevision | |||
Media::setCreatedTime | public | function | Sets the media item creation timestamp. | Overrides MediaInterface::setCreatedTime | |||
Media::setName | public | function | Sets the media item name. | Overrides MediaInterface::setName | |||
Media::shouldUpdateThumbnail | protected | function | Determines if the thumbnail should be updated for a media item. | ||||
Media::updateQueuedThumbnail | public | function | Updates the queued thumbnail for the media item. | ||||
Media::updateThumbnail | protected | function | Update the thumbnail for the media item. | ||||
Media::validate | public | function | Overrides ContentEntityBase::validate | ||||
RefinableCacheableDependencyTrait::addCacheableDependency | public | function | 1 | ||||
RefinableCacheableDependencyTrait::addCacheContexts | public | function | |||||
RefinableCacheableDependencyTrait::addCacheTags | public | function | |||||
RefinableCacheableDependencyTrait::mergeCacheMaxAge | public | function | |||||
RevisionLogEntityTrait::getRevisionCreationTime | public | function | Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionCreationTime(). | 1 | |||
RevisionLogEntityTrait::getRevisionLogMessage | public | function | Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionLogMessage(). | 1 | |||
RevisionLogEntityTrait::getRevisionMetadataKey | protected static | function | Gets the name of a revision metadata field. | ||||
RevisionLogEntityTrait::getRevisionUser | public | function | Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUser(). | 1 | |||
RevisionLogEntityTrait::getRevisionUserId | public | function | Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUserId(). | 1 | |||
RevisionLogEntityTrait::revisionLogBaseFieldDefinitions | public static | function | Provides revision-related base field definitions for an entity type. | ||||
RevisionLogEntityTrait::setRevisionCreationTime | public | function | Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionCreationTime(). | 1 | |||
RevisionLogEntityTrait::setRevisionLogMessage | public | function | Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionLogMessage(). | 1 | |||
RevisionLogEntityTrait::setRevisionUser | public | function | Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUser(). | 1 | |||
RevisionLogEntityTrait::setRevisionUserId | public | function | Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUserId(). | 1 | |||
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | ||||
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | ||||
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | ||||
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | ||||
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | |||
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | ||||
SynchronizableEntityTrait::$isSyncing | protected | property | Whether this entity is being created, updated or deleted through a 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.