interface EmbedTrackInterface in Entity Usage 8.3

Defines the interface for tracking plugins that embed entities in WYSIWYG.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\entity_usage\EntityUsageTrackInterface
    • interface \Drupal\entity_usage\EmbedTrackInterface

1 file declares its use of EmbedTrackInterface

TextFieldEmbedBase.php in src/Plugin/EntityUsage/Track/TextFieldEmbedBase.php

File

src/EmbedTrackInterface.php, line 8

Namespace

Drupal\entity_usage

interface EmbedTrackInterface extends EntityUsageTrackInterface {

  /**
   * Parse an HTML snippet looking for embedded entities.
   *
   * @param string $text
   *   The partial (X)HTML snippet to load. Invalid markup will be corrected on
   *   import.
   *
   * @return array
   *   An array of all embedded entities found, where keys are the uuids and the
   *   values are the entity types.
   */
  public function parseEntitiesFromText($text);

}

Members

Name	Modifiers	Type	Description	Overrides
EmbedTrackInterface::parseEntitiesFromText	public	function	Parse an HTML snippet looking for embedded entities.	3
EntityUsageTrackInterface::getApplicableFieldTypes	public	function	Returns the field types this plugin is capable of tracking.	1
EntityUsageTrackInterface::getDescription	public	function	Returns the tracking method description.	1
EntityUsageTrackInterface::getId	public	function	Returns the tracking method unique id.	1
EntityUsageTrackInterface::getLabel	public	function	Returns the tracking method label.	1
EntityUsageTrackInterface::getReferencingFields	public	function	Retrieve fields of the given types on an entity.	1
EntityUsageTrackInterface::getTargetEntities	public	function	Retrieve the target entity(ies) from a field item value.	5
EntityUsageTrackInterface::trackOnEntityCreation	public	function	Track usage updates on the creation of entities.	1
EntityUsageTrackInterface::trackOnEntityUpdate	public	function	Track usage updates on the edition of entities.	1
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2