class EntityEmbedDisplay in Entity Embed 8

Defines an Entity Embed Display plugin annotation object.

Plugin Namespace: Plugin/entity_embed/EntityEmbedDisplay.

For a working example, see \Drupal\entity_embed\Plugin\entity_embed\EntityEmbedDisplay\FileFieldFormatter

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\entity_embed\Annotation\EntityEmbedDisplay

See also

\Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayBase

\Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayInterface

\Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayManager

Plugin API

4 classes are annotated with EntityEmbedDisplay

EntityReferenceFieldFormatter in src/Plugin/entity_embed/EntityEmbedDisplay/EntityReferenceFieldFormatter.php

Entity Embed Display reusing entity reference field formatters.

FileFieldFormatter in src/Plugin/entity_embed/EntityEmbedDisplay/FileFieldFormatter.php

Entity Embed Display reusing file field formatters.

ImageFieldFormatter in src/Plugin/entity_embed/EntityEmbedDisplay/ImageFieldFormatter.php

Entity Embed Display reusing image field formatters.

ViewModeFieldFormatter in src/Plugin/entity_embed/EntityEmbedDisplay/ViewModeFieldFormatter.php

Entity Embed Display reusing entity reference field formatters.

File

src/Annotation/EntityEmbedDisplay.php, line 23

Namespace

Drupal\entity_embed\Annotation

class EntityEmbedDisplay extends Plugin {

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

  /**
   * The human-readable name of the Entity Embed Display plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label = '';

  /**
   * The entity types the Entity Embed Display plugin can apply to.
   *
   * To make the Entity Embed Display plugin valid for all entity types, set
   * this value to FALSE.
   *
   * @var bool|array
   */
  public $entity_types = FALSE;

  /**
   * Shows plugin in the UI if this is FALSE.
   *
   * @var bool
   */
  public $no_ui = FALSE;

  /**
   * Alt and title access.
   *
   * Whether the plugin supports per-embed alt and title overrides for media
   * entities with an image source.
   *
   * @var bool
   */
  public $supports_image_alt_and_title = FALSE;

}

Members

Name	Modifiers	Type	Description	Overrides
EntityEmbedDisplay::$entity_types	public	property	The entity types the Entity Embed Display plugin can apply to.
EntityEmbedDisplay::$id	public	property	The plugin ID.
EntityEmbedDisplay::$label	public	property	The human-readable name of the Entity Embed Display plugin.
EntityEmbedDisplay::$no_ui	public	property	Shows plugin in the UI if this is FALSE.
EntityEmbedDisplay::$supports_image_alt_and_title	public	property	Alt and title access.
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