interface MediaInterface

Same name and namespace in other branches
  1. 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

11 files declare their use of MediaInterface
EditorMediaDialog.php in core/modules/media/src/Form/EditorMediaDialog.php
File.php in core/modules/media/src/Plugin/media/Source/File.php
Image.php in core/modules/media/src/Plugin/media/Source/Image.php
Media.php in core/modules/media/src/Entity/Media.php
MediaCreationTest.php in core/modules/media/tests/src/Kernel/MediaCreationTest.php

... See full list

File

core/modules/media/src/MediaInterface.php, line 14

Namespace

Drupal\media
View on git.drupalcode.org
View 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 Modifiers Object type Summary Overrides
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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.