interface MediaInterface
Same name in other branches
- 8.9.x core/modules/media/src/MediaInterface.php \Drupal\media\MediaInterface
- 10 core/modules/media/src/MediaInterface.php \Drupal\media\MediaInterface
- 11.x core/modules/media/src/MediaInterface.php \Drupal\media\MediaInterface
Provides an interface defining an entity for media items.
Hierarchy
- interface \Drupal\media\MediaInterface extends \Drupal\Core\Entity\ContentEntityInterface \Drupal\Core\Entity\EntityChangedInterface \Drupal\Core\Entity\RevisionLogInterface \Drupal\user\EntityOwnerInterface \Drupal\Core\Entity\EntityPublishedInterface
Expanded class hierarchy of MediaInterface
All classes that implement MediaInterface
15 files declare their use of MediaInterface
- AddFormBase.php in core/
modules/ media_library/ src/ Form/ AddFormBase.php - CKEditor5MediaController.php in core/
modules/ ckeditor5/ src/ Controller/ CKEditor5MediaController.php - EditorMediaDialog.php in core/
modules/ media/ src/ Form/ EditorMediaDialog.php - File.php in core/
modules/ media/ src/ Plugin/ media/ Source/ File.php - FileUploadForm.php in core/
modules/ media_library/ src/ Form/ FileUploadForm.php
File
-
core/
modules/ media/ src/ MediaInterface.php, line 14
Namespace
Drupal\mediaView source
interface MediaInterface extends ContentEntityInterface, EntityChangedInterface, RevisionLogInterface, EntityOwnerInterface, EntityPublishedInterface {
/**
* Gets the media item name.
*
* @return string
* The name of the media item.
*/
public function getName();
/**
* Sets the media item name.
*
* @param string $name
* The name of the media item.
*
* @return $this
*/
public function setName($name);
/**
* Returns the media item creation timestamp.
*
* @todo Remove and use the new interface when #2833378 is done.
* @see https://www.drupal.org/node/2833378
*
* @return int
* Creation timestamp of the media item.
*/
public function getCreatedTime();
/**
* Sets the media item creation timestamp.
*
* @todo Remove and use the new interface when #2833378 is done.
* @see https://www.drupal.org/node/2833378
*
* @param int $timestamp
* The media creation timestamp.
*
* @return $this
* The called media item.
*/
public function setCreatedTime($timestamp);
/**
* Returns the media source.
*
* @return \Drupal\media\MediaSourceInterface
* The media source.
*/
public function getSource();
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
AccessibleInterface::access | public | function | Checks data value access. | 9 |
CacheableDependencyInterface::getCacheContexts | public | function | The cache contexts associated with this object. | 34 |
CacheableDependencyInterface::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | 34 |
CacheableDependencyInterface::getCacheTags | public | function | The cache tags associated with this object. | 27 |
EntityChangedInterface::getChangedTime | public | function | Gets the timestamp of the last entity change for the current translation. | |
EntityChangedInterface::getChangedTimeAcrossTranslations | public | function | Gets the timestamp of the last entity change across all translations. | |
EntityChangedInterface::setChangedTime | public | function | Sets the timestamp of the last entity change for the current translation. | |
EntityInterface::bundle | public | function | Gets the bundle of the entity. | 2 |
EntityInterface::create | public static | function | Constructs a new entity object, without permanently saving it. | 2 |
EntityInterface::createDuplicate | public | function | Creates a duplicate of the entity. | 2 |
EntityInterface::delete | public | function | Deletes an entity permanently. | 2 |
EntityInterface::enforceIsNew | public | function | Enforces an entity to be new. | 2 |
EntityInterface::getCacheTagsToInvalidate | public | function | Returns the cache tags that should be used to invalidate caches. | 2 |
EntityInterface::getConfigDependencyKey | public | function | Gets the key that is used to store configuration dependencies. | 2 |
EntityInterface::getConfigDependencyName | public | function | Gets the configuration dependency name. | 2 |
EntityInterface::getConfigTarget | public | function | Gets the configuration target identifier for the entity. | 2 |
EntityInterface::getEntityType | public | function | Gets the entity type definition. | 2 |
EntityInterface::getEntityTypeId | public | function | Gets the ID of the type of the entity. | 2 |
EntityInterface::getOriginalId | public | function | Gets the original ID. | 2 |
EntityInterface::getTypedData | public | function | Gets a typed data object for this entity object. | 2 |
EntityInterface::hasLinkTemplate | public | function | Indicates if a link template exists for a given key. | 2 |
EntityInterface::id | public | function | Gets the identifier. | 2 |
EntityInterface::isNew | public | function | Determines whether the entity is new. | 2 |
EntityInterface::label | public | function | Gets the label of the entity. | 2 |
EntityInterface::language | public | function | Gets the language of the entity. | 2 |
EntityInterface::load | public static | function | Loads an entity. | 2 |
EntityInterface::loadMultiple | public static | function | Loads one or more entities. | 2 |
EntityInterface::postCreate | public | function | Acts on a created entity before hooks are invoked. | 2 |
EntityInterface::postDelete | public static | function | Acts on deleted entities before the delete hook is invoked. | 2 |
EntityInterface::postLoad | public static | function | Acts on loaded entities. | 3 |
EntityInterface::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. | 2 |
EntityInterface::preCreate | public static | function | Changes the values of an entity before it is created. | 2 |
EntityInterface::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. | 2 |
EntityInterface::preSave | public | function | Acts on an entity before the presave hook is invoked. | 2 |
EntityInterface::referencedEntities | public | function | Gets a list of entities referenced by this entity. | 2 |
EntityInterface::save | public | function | Saves an entity permanently. | 2 |
EntityInterface::setOriginalId | public | function | Sets the original ID. | 2 |
EntityInterface::toArray | public | function | Gets an array of all property values. | 3 |
EntityInterface::toLink | public | function | Generates the HTML for a link to this entity. | 2 |
EntityInterface::toUrl | public | function | Gets the URL object for the entity. | 2 |
EntityInterface::uriRelationships | public | function | Gets a list of URI relationships supported by this entity. | 2 |
EntityInterface::uuid | public | function | Gets the entity UUID (Universally Unique Identifier). | 2 |
EntityOwnerInterface::getOwner | public | function | Returns the entity owner's user entity. | 1 |
EntityOwnerInterface::getOwnerId | public | function | Returns the entity owner's user ID. | 1 |
EntityOwnerInterface::setOwner | public | function | Sets the entity owner's user entity. | 1 |
EntityOwnerInterface::setOwnerId | public | function | Sets the entity owner's user ID. | 1 |
EntityPublishedInterface::isPublished | public | function | Returns whether or not the entity is published. | |
EntityPublishedInterface::setPublished | public | function | Sets the entity as published. | |
EntityPublishedInterface::setUnpublished | public | function | Sets the entity as unpublished. | |
MediaInterface::getCreatedTime | public | function | Returns the media item creation timestamp. | 1 |
MediaInterface::getName | public | function | Gets the media item name. | 1 |
MediaInterface::getSource | public | function | Returns the media source. | 1 |
MediaInterface::setCreatedTime | public | function | Sets the media item creation timestamp. | 1 |
MediaInterface::setName | public | function | Sets the media item name. | 1 |
RefinableCacheableDependencyInterface::addCacheableDependency | public | function | Adds a dependency on an object: merges its cacheability metadata. | 1 |
RefinableCacheableDependencyInterface::addCacheContexts | public | function | Adds cache contexts. | 1 |
RefinableCacheableDependencyInterface::addCacheTags | public | function | Adds cache tags. | 1 |
RefinableCacheableDependencyInterface::mergeCacheMaxAge | public | function | Merges the maximum age (in seconds) with the existing maximum age. | 1 |
RevisionableInterface::getLoadedRevisionId | public | function | Gets the loaded Revision ID of the entity. | |
RevisionableInterface::getRevisionId | public | function | Gets the revision identifier of the entity. | |
RevisionableInterface::isDefaultRevision | public | function | Checks if this entity is the default revision. | |
RevisionableInterface::isLatestRevision | public | function | Checks if this entity is the latest revision. | |
RevisionableInterface::isNewRevision | public | function | Determines whether a new revision should be created on save. | |
RevisionableInterface::preSaveRevision | public | function | Acts on a revision before it gets saved. | |
RevisionableInterface::setNewRevision | public | function | Enforces an entity to be saved as a new revision. | |
RevisionableInterface::updateLoadedRevisionId | public | function | Updates the loaded Revision ID with the revision ID. | |
RevisionableInterface::wasDefaultRevision | public | function | Checks whether the entity object was a default revision when it was saved. | |
RevisionLogInterface::getRevisionCreationTime | public | function | Gets the entity revision creation timestamp. | 1 |
RevisionLogInterface::getRevisionLogMessage | public | function | Returns the entity revision log message. | |
RevisionLogInterface::getRevisionUser | public | function | Gets the entity revision author. | |
RevisionLogInterface::getRevisionUserId | public | function | Gets the entity revision author ID. | |
RevisionLogInterface::setRevisionCreationTime | public | function | Sets the entity revision creation timestamp. | 1 |
RevisionLogInterface::setRevisionLogMessage | public | function | Sets the entity revision log message. | |
RevisionLogInterface::setRevisionUser | public | function | Sets the entity revision author. | |
RevisionLogInterface::setRevisionUserId | public | function | Sets the entity revision author by ID. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.