class MediaType in Media entity 8

Defines an media entity type plugin annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\media_entity\Annotation\MediaType

See also

hook_media_entity_type_info_alter()

2 classes are annotated with MediaType

Generic in src/Plugin/MediaEntity/Type/Generic.php

Provides generic media type.

TestType in tests/modules/media_entity_test_type/src/Plugin/MediaEntity/Type/TestType.php

Provides generic media type.

File

src/Annotation/MediaType.php, line 14

Namespace

Drupal\media_entity\Annotation

class MediaType extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the type.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $label;

  /**
   * A brief description of the plugin.
   *
   * This will be shown when adding or configuring this display.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation (optional)
   */
  public $description = '';

}

Members

Name	Modifiers	Type	Description	Overrides
MediaType::$description	public	property	A brief description of the plugin.
MediaType::$id	public	property	The plugin ID.
MediaType::$label	public	property	The human-readable name of the type.
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2