class MediaType
Same name and namespace in other branches
- 10 core/modules/media/src/Entity/MediaType.php \Drupal\media\Entity\MediaType
- 9 core/modules/media/src/Entity/MediaType.php \Drupal\media\Entity\MediaType
- 8.9.x core/modules/media/src/Entity/MediaType.php \Drupal\media\Entity\MediaType
Defines the Media type configuration entity.
Attributes
#[ConfigEntityType(id: 'media_type', label: new TranslatableMarkup('Media type'), label_collection: new TranslatableMarkup('Media types'), label_singular: new TranslatableMarkup('media type'), label_plural: new TranslatableMarkup('media types'), config_prefix: 'type', entity_keys: [
'id' => 'id',
'label' => 'label',
'status' => 'status',
], handlers: [
'access' => MediaTypeAccessControlHandler::class,
'form' => [
'add' => MediaTypeForm::class,
'edit' => MediaTypeForm::class,
'delete' => MediaTypeDeleteConfirmForm::class,
],
'list_builder' => MediaTypeListBuilder::class,
'route_provider' => [
'html' => DefaultHtmlRouteProvider::class,
'permissions' => EntityPermissionsRouteProvider::class,
],
], links: [
'add-form' => '/admin/structure/media/add',
'edit-form' => '/admin/structure/media/manage/{media_type}',
'delete-form' => '/admin/structure/media/manage/{media_type}/delete',
'entity-permissions-form' => '/admin/structure/media/manage/{media_type}/permissions',
'collection' => '/admin/structure/media',
], admin_permission: 'administer media types', bundle_of: 'media', label_count: [
'singular' => '@count media type',
'plural' => '@count media types',
], constraints: [
'ImmutableProperties' => [
'properties' => [
'id',
'source',
],
],
'MediaMappingsConstraint' => [],
], config_export: [
'id',
'label',
'description',
'source',
'queue_thumbnail_downloads',
'new_revision',
'source_configuration',
'field_map',
'status',
])]
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\EntityInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements \Drupal\Core\Config\Entity\ConfigEntityInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase
- class \Drupal\Core\Config\Entity\ConfigEntityBundleBase extends \Drupal\Core\Config\Entity\ConfigEntityBase
- class \Drupal\media\Entity\MediaType implements \Drupal\media\MediaTypeInterface, \Drupal\Core\Entity\EntityWithPluginCollectionInterface extends \Drupal\Core\Config\Entity\ConfigEntityBundleBase
- class \Drupal\Core\Config\Entity\ConfigEntityBundleBase extends \Drupal\Core\Config\Entity\ConfigEntityBase
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements \Drupal\Core\Config\Entity\ConfigEntityInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase
Expanded class hierarchy of MediaType
24 files declare their use of MediaType
- ConfigActionsTest.php in core/
modules/ media/ tests/ src/ Kernel/ ConfigActionsTest.php - EntityLinksTest.php in core/
modules/ filter/ tests/ src/ Kernel/ EntityLinksTest.php - Media.php in core/
modules/ ckeditor5/ src/ Plugin/ CKEditor5Plugin/ Media.php - MediaCreationTest.php in core/
modules/ media/ tests/ src/ Kernel/ MediaCreationTest.php - MediaLibraryDisplayModeTest.php in core/
modules/ media_library/ tests/ src/ Functional/ MediaLibraryDisplayModeTest.php
File
-
core/
modules/ media/ src/ Entity/ MediaType.php, line 22
Namespace
Drupal\media\EntityView source
class MediaType extends ConfigEntityBundleBase implements MediaTypeInterface, EntityWithPluginCollectionInterface {
/**
* The machine name of this media type.
*
* @var string
*/
protected $id;
/**
* The human-readable name of the media type.
*
* @var string
*/
protected $label;
/**
* A brief description of this media type.
*
* @var string
*/
protected $description;
/**
* The media source ID.
*
* @var string
*/
protected $source;
/**
* Whether media items should be published by default.
*
* @var bool
*/
protected $status = TRUE;
/**
* Whether thumbnail downloads are queued.
*
* @var bool
*
* @see \Drupal\media\MediaTypeInterface::thumbnailDownloadsAreQueued()
*/
protected $queue_thumbnail_downloads = FALSE;
/**
* Default value of the 'Create new revision' checkbox of this media type.
*
* @var bool
*/
protected $new_revision = FALSE;
/**
* The media source configuration.
*
* A media source can provide a configuration form with source plugin-specific
* configuration settings, which must at least include a source_field element
* containing a the name of the source field for the media type. The source
* configuration is defined by, and used to load, the source plugin. See
* \Drupal\media\MediaTypeInterface for an explanation of media sources.
*
* @var array
*
* @see \Drupal\media\MediaTypeInterface::getSource()
*/
protected $source_configuration = [];
/**
* Lazy collection for the media source.
*
* @var \Drupal\Core\Plugin\DefaultSingleLazyPluginCollection
*/
protected $sourcePluginCollection;
/**
* The metadata field map.
*
* @var array
*
* @see \Drupal\media\MediaTypeInterface::getFieldMap()
*/
protected $field_map = [];
/**
* {@inheritdoc}
*/
public function getPluginCollections() {
return [
'source_configuration' => $this->sourcePluginCollection(),
];
}
/**
* {@inheritdoc}
*/
public function getDescription() {
return $this->description;
}
/**
* {@inheritdoc}
*/
public function setDescription($description) {
return $this->set('description', $description);
}
/**
* {@inheritdoc}
*/
public function thumbnailDownloadsAreQueued() {
return $this->queue_thumbnail_downloads;
}
/**
* {@inheritdoc}
*/
public function setQueueThumbnailDownloadsStatus($queue_thumbnail_downloads) {
return $this->set('queue_thumbnail_downloads', $queue_thumbnail_downloads);
}
/**
* {@inheritdoc}
*/
public function getSource() {
return $this->sourcePluginCollection()
->get($this->source);
}
/**
* Returns media source lazy plugin collection.
*
* @return \Drupal\Core\Plugin\DefaultSingleLazyPluginCollection|null
* The tag plugin collection or NULL if the plugin ID was not set yet.
*/
protected function sourcePluginCollection() {
if (!$this->sourcePluginCollection && $this->source) {
$this->sourcePluginCollection = new DefaultSingleLazyPluginCollection(\Drupal::service('plugin.manager.media.source'), $this->source, $this->source_configuration);
}
return $this->sourcePluginCollection;
}
/**
* {@inheritdoc}
*/
public function getStatus() {
return $this->status;
}
/**
* {@inheritdoc}
*/
public function shouldCreateNewRevision() {
return $this->new_revision;
}
/**
* {@inheritdoc}
*/
public function setNewRevision($new_revision) {
return $this->set('new_revision', $new_revision);
}
/**
* {@inheritdoc}
*/
public function getFieldMap() {
return $this->field_map;
}
/**
* {@inheritdoc}
*/
public function setFieldMap(array $map) {
return $this->set('field_map', $map);
}
}
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. | |||
| ConfigEntityBase::$isUninstalling | private | property | Whether the config is being deleted by the uninstall process. | |||
| ConfigEntityBase::$langcode | protected | property | The language code of the entity's default language. | |||
| ConfigEntityBase::$originalId | protected | property | The original ID of the configuration entity. | |||
| ConfigEntityBase::$third_party_settings | protected | property | Third party entity settings. | |||
| ConfigEntityBase::$trustedData | protected | property | Trust supplied data and not use configuration schema on save. | |||
| ConfigEntityBase::$uuid | protected | property | The UUID for this entity. | |||
| ConfigEntityBase::$_core | protected | property | Information maintained by Drupal core about configuration. | |||
| ConfigEntityBase::addDependency | protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |||
| ConfigEntityBase::calculateDependencies | public | function | Overrides ConfigEntityInterface::calculateDependencies | 12 | ||
| ConfigEntityBase::createDuplicate | public | function | Overrides EntityBase::createDuplicate | 1 | ||
| ConfigEntityBase::disable | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Disable'), pluralize: FALSE)] | Overrides ConfigEntityInterface::disable | 1 | |
| ConfigEntityBase::enable | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Enable'), pluralize: FALSE)] | Overrides ConfigEntityInterface::enable | ||
| ConfigEntityBase::get | public | function | Overrides ConfigEntityInterface::get | |||
| ConfigEntityBase::getCacheTagsToInvalidate | public | function | Overrides EntityBase::getCacheTagsToInvalidate | 2 | ||
| ConfigEntityBase::getConfigDependencyName | public | function | Overrides EntityBase::getConfigDependencyName | |||
| ConfigEntityBase::getConfigManager | protected static | function | Gets the configuration manager. | |||
| ConfigEntityBase::getConfigTarget | public | function | Overrides EntityBase::getConfigTarget | |||
| ConfigEntityBase::getDependencies | public | function | Overrides ConfigEntityInterface::getDependencies | |||
| ConfigEntityBase::getOriginalId | public | function | Overrides EntityBase::getOriginalId | |||
| ConfigEntityBase::getThirdPartyProviders | public | function | Overrides ThirdPartySettingsInterface::getThirdPartyProviders | |||
| ConfigEntityBase::getThirdPartySetting | public | function | Overrides ThirdPartySettingsInterface::getThirdPartySetting | |||
| ConfigEntityBase::getThirdPartySettings | public | function | Overrides ThirdPartySettingsInterface::getThirdPartySettings | |||
| ConfigEntityBase::getTypedConfig | protected | function | Gets the typed config manager. | |||
| ConfigEntityBase::hasTrustedData | public | function | Overrides ConfigEntityInterface::hasTrustedData | |||
| ConfigEntityBase::invalidateTagsOnDelete | protected static | function | Override to never invalidate the individual entities' cache tags; the config system already invalidates them. |
Overrides EntityBase::invalidateTagsOnDelete | ||
| ConfigEntityBase::invalidateTagsOnSave | protected | function | Override to never invalidate the entity's cache tag; the config system already invalidates it. |
Overrides EntityBase::invalidateTagsOnSave | ||
| ConfigEntityBase::isInstallable | public | function | Overrides ConfigEntityInterface::isInstallable | 2 | ||
| ConfigEntityBase::isNew | public | function | Overrides EntityBase::isNew(). | Overrides EntityBase::isNew | ||
| ConfigEntityBase::isUninstalling | public | function | Overrides ConfigEntityInterface::isUninstalling | |||
| ConfigEntityBase::onDependencyRemoval | public | function | Overrides ConfigEntityInterface::onDependencyRemoval | 8 | ||
| ConfigEntityBase::preDelete | public static | function | Overrides EntityBase::preDelete | 8 | ||
| ConfigEntityBase::save | public | function | Overrides EntityBase::save | 2 | ||
| ConfigEntityBase::set | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Set a value'), pluralize: 'setMultiple')] | Overrides ConfigEntityInterface::set | 1 | |
| ConfigEntityBase::setOriginalId | public | function | Overrides EntityBase::setOriginalId | |||
| ConfigEntityBase::setStatus | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Set status'), pluralize: FALSE)] | Overrides ConfigEntityInterface::setStatus | ||
| ConfigEntityBase::setThirdPartySetting | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Set third-party setting'))] | Overrides ThirdPartySettingsInterface::setThirdPartySetting | ||
| ConfigEntityBase::setUninstalling | public | function | ||||
| ConfigEntityBase::sort | public static | function | Callback for uasort() to sort configuration entities by weight and label. | 6 | ||
| ConfigEntityBase::status | public | function | Overrides ConfigEntityInterface::status | 4 | ||
| ConfigEntityBase::toArray | public | function | Overrides EntityBase::toArray | 3 | ||
| ConfigEntityBase::toUrl | public | function | Overrides EntityBase::toUrl | |||
| ConfigEntityBase::trustData | public | function | Overrides ConfigEntityInterface::trustData | |||
| ConfigEntityBase::unsetThirdPartySetting | public | function | Overrides ThirdPartySettingsInterface::unsetThirdPartySetting | |||
| ConfigEntityBase::__construct | public | function | Overrides EntityBase::__construct | 9 | ||
| ConfigEntityBase::__sleep | public | function | Overrides EntityBase::__sleep | 4 | ||
| ConfigEntityBundleBase::deleteDisplays | protected | function | Deletes display if a bundle is deleted. | |||
| ConfigEntityBundleBase::loadDisplays | protected | function | Returns view or form displays for this bundle. | |||
| ConfigEntityBundleBase::postDelete | public static | function | Overrides EntityBase::postDelete | 2 | ||
| ConfigEntityBundleBase::postSave | public | function | Overrides EntityBase::postSave | 2 | ||
| ConfigEntityBundleBase::preSave | public | function | Acts on an entity before the presave hook is invoked. | Overrides ConfigEntityBase::preSave | ||
| 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 | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | 2 | |||
| DependencyTrait::$dependencies | protected | property | The object's dependencies. | |||
| DependencyTrait::addDependencies | protected | function | Adds multiple dependencies. | |||
| DependencyTrait::addDependency | protected | function | Adds a dependency. | Aliased as: addDependencyTrait | ||
| EntityBase::$enforceIsNew | protected | property | Boolean indicating whether the entity should be forced to be new. | |||
| EntityBase::$entityTypeId | protected | property | The entity type. | |||
| EntityBase::$originalEntity | protected | property | The original unchanged entity. | |||
| EntityBase::$typedData | protected | property | A typed data object wrapping this entity. | |||
| EntityBase::access | public | function | Overrides AccessibleInterface::access | 1 | ||
| EntityBase::bundle | public | function | Overrides EntityInterface::bundle | 1 | ||
| EntityBase::create | public static | function | Overrides EntityInterface::create | 2 | ||
| EntityBase::delete | public | function | Overrides EntityInterface::delete | 1 | ||
| EntityBase::enforceIsNew | public | function | 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 | Overrides CacheableDependencyTrait::getCacheContexts | |||
| EntityBase::getCacheMaxAge | public | function | Overrides CacheableDependencyTrait::getCacheMaxAge | |||
| EntityBase::getCacheTags | public | function | Overrides CacheableDependencyTrait::getCacheTags | |||
| EntityBase::getConfigDependencyKey | public | function | Overrides EntityInterface::getConfigDependencyKey | |||
| EntityBase::getEntityType | public | function | Overrides EntityInterface::getEntityType | 1 | ||
| EntityBase::getEntityTypeId | public | function | Overrides EntityInterface::getEntityTypeId | |||
| EntityBase::getListCacheTagsToInvalidate | protected | function | The list cache tags to invalidate for this entity. | |||
| EntityBase::getOriginal | public | function | Overrides EntityInterface::getOriginal | |||
| EntityBase::getTypedData | public | function | Overrides EntityInterface::getTypedData | |||
| EntityBase::getTypedDataClass | private | function | Returns the typed data class name for this entity. | |||
| EntityBase::hasLinkTemplate | public | function | Overrides EntityInterface::hasLinkTemplate | |||
| EntityBase::id | public | function | Overrides EntityInterface::id | 10 | ||
| EntityBase::label | public | function | Overrides EntityInterface::label | 6 | ||
| EntityBase::language | public | function | Overrides EntityInterface::language | 1 | ||
| EntityBase::languageManager | protected | function | Gets the language manager. | |||
| EntityBase::linkTemplates | protected | function | Gets an array link templates. | 1 | ||
| EntityBase::load | public static | function | Overrides EntityInterface::load | |||
| EntityBase::loadMultiple | public static | function | Overrides EntityInterface::loadMultiple | |||
| EntityBase::postCreate | public | function | Overrides EntityInterface::postCreate | 5 | ||
| EntityBase::postLoad | public static | function | Overrides EntityInterface::postLoad | 3 | ||
| EntityBase::preCreate | public static | function | Overrides EntityInterface::preCreate | 6 | ||
| EntityBase::referencedEntities | public | function | Overrides EntityInterface::referencedEntities | 1 | ||
| EntityBase::setOriginal | public | function | Overrides EntityInterface::setOriginal | |||
| EntityBase::toLink | public | function | Overrides EntityInterface::toLink | |||
| EntityBase::uriRelationships | public | function | Overrides EntityInterface::uriRelationships | |||
| EntityBase::urlRouteParameters | protected | function | Gets an array of placeholders for this entity. | 2 | ||
| EntityBase::uuid | public | function | Overrides EntityInterface::uuid | 1 | ||
| EntityBase::uuidGenerator | protected | function | Gets the UUID generator. | |||
| EntityBase::__get | public | function | 1 | |||
| EntityBase::__isset | public | function | 1 | |||
| EntityBase::__set | public | function | 1 | |||
| EntityBase::__unset | public | function | 1 | |||
| MediaType::$description | protected | property | A brief description of this media type. | |||
| MediaType::$field_map | protected | property | The metadata field map. | |||
| MediaType::$id | protected | property | The machine name of this media type. | |||
| MediaType::$label | protected | property | The human-readable name of the media type. | |||
| MediaType::$new_revision | protected | property | Default value of the 'Create new revision' checkbox of this media type. | |||
| MediaType::$queue_thumbnail_downloads | protected | property | Whether thumbnail downloads are queued. | |||
| MediaType::$source | protected | property | The media source ID. | |||
| MediaType::$sourcePluginCollection | protected | property | Lazy collection for the media source. | |||
| MediaType::$source_configuration | protected | property | The media source configuration. | |||
| MediaType::$status | protected | property | Whether media items should be published by default. | Overrides ConfigEntityBase::$status | ||
| MediaType::getDescription | public | function | Gets the entity description. | Overrides EntityDescriptionInterface::getDescription | ||
| MediaType::getFieldMap | public | function | Returns the metadata field map. | Overrides MediaTypeInterface::getFieldMap | ||
| MediaType::getPluginCollections | public | function | Gets the plugin collections used by this object. | Overrides ObjectWithPluginCollectionInterface::getPluginCollections | ||
| MediaType::getSource | public | function | Returns the media source plugin. | Overrides MediaTypeInterface::getSource | ||
| MediaType::getStatus | public | function | ||||
| MediaType::setDescription | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Set description'), pluralize: FALSE)] | Overrides EntityDescriptionInterface::setDescription | ||
| MediaType::setFieldMap | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Set field mapping'), pluralize: FALSE)] | Overrides MediaTypeInterface::setFieldMap | ||
| MediaType::setNewRevision | public | function | Sets whether new revisions should be created by default. | Overrides MediaTypeInterface::setNewRevision | ||
| MediaType::setQueueThumbnailDownloadsStatus | public | function | Sets a flag to indicate that thumbnails should be downloaded via a queue. | Overrides MediaTypeInterface::setQueueThumbnailDownloadsStatus | ||
| MediaType::shouldCreateNewRevision | public | function | Gets whether a new revision should be created by default. | Overrides RevisionableEntityBundleInterface::shouldCreateNewRevision | ||
| MediaType::sourcePluginCollection | protected | function | Returns media source lazy plugin collection. | |||
| MediaType::thumbnailDownloadsAreQueued | public | function | Returns whether thumbnail downloads are queued. | Overrides MediaTypeInterface::thumbnailDownloadsAreQueued | ||
| PluginDependencyTrait::calculatePluginDependencies | protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 | ||
| PluginDependencyTrait::getPluginDependencies | protected | function | Calculates and returns dependencies of a specific plugin instance. | |||
| PluginDependencyTrait::moduleHandler | protected | function | Wraps the module handler. | 1 | ||
| PluginDependencyTrait::themeHandler | protected | function | Wraps the theme handler. | 1 | ||
| 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 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.