class MediaType

Same name and namespace in other branches
  1. 9 core/modules/media/src/Entity/MediaType.php \Drupal\media\Entity\MediaType
  2. 8.9.x core/modules/media/src/Entity/MediaType.php \Drupal\media\Entity\MediaType
  3. 11.x core/modules/media/src/Entity/MediaType.php \Drupal\media\Entity\MediaType

Defines the Media type configuration entity.

Plugin annotation


@ConfigEntityType(
  id = "media_type",
  label = @Translation("Media type"),
  label_collection = @Translation("Media types"),
  label_singular = @Translation("media type"),
  label_plural = @Translation("media types"),
  label_count = @PluralTranslation(
    singular = "@count media type",
    plural = "@count media types"
  ),
  handlers = {
    "access" = "Drupal\media\MediaTypeAccessControlHandler",
    "form" = {
      "add" = "Drupal\media\MediaTypeForm",
      "edit" = "Drupal\media\MediaTypeForm",
      "delete" = "Drupal\media\Form\MediaTypeDeleteConfirmForm"
    },
    "list_builder" = "Drupal\media\MediaTypeListBuilder",
    "route_provider" = {
      "html" = "Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider",
      "permissions" = "Drupal\user\Entity\EntityPermissionsRouteProvider",
    }
  },
  admin_permission = "administer media types",
  config_prefix = "type",
  bundle_of = "media",
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "status" = "status",
  },
  config_export = {
    "id",
    "label",
    "description",
    "source",
    "queue_thumbnail_downloads",
    "new_revision",
    "source_configuration",
    "field_map",
    "status",
  },
  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",
  },
  constraints = {
    "ImmutableProperties" = {"id", "source"},
    "MediaMappingsConstraint" = { },
  }
)

Hierarchy

Expanded class hierarchy of MediaType

23 files declare their use of MediaType
media.install in core/modules/media/media.install
Install, uninstall and update hooks for Media module.
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
MediaLibraryWidgetTest.php in core/modules/media_library/tests/src/Kernel/MediaLibraryWidgetTest.php

... See full list

File

core/modules/media/src/Entity/MediaType.php, line 68

Namespace

Drupal\media\Entity
View 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
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
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies 13
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. 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 Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 8
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 2
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 3
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
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 Acts on deleted entities before the delete hook is invoked. Overrides EntityBase::postDelete 2
ConfigEntityBundleBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. 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
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 1
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::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create 2
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::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
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::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::id public function Gets the identifier. Overrides EntityInterface::id 10
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. 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 Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 5
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 3
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 6
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
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::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
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
MediaType::getSource public function Returns the media source plugin. Overrides MediaTypeInterface::getSource
MediaType::getStatus public function
MediaType::setDescription public function Sets the entity description. Overrides EntityDescriptionInterface::setDescription
MediaType::setFieldMap public function Sets the metadata field map. 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.