class TextFieldEmbedBase in Group Media 8.2

Class TextFieldEmbedBase.

@package Drupal\entity_usage\Plugin\EntityUsage\Track

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\groupmedia\Plugin\MediaFinder\MediaFinderBase implements ContainerFactoryPluginInterface, MediaFinderInterface
      • class \Drupal\groupmedia\Plugin\MediaFinder\TextFieldEmbedBase

File

src/Plugin/MediaFinder/TextFieldEmbedBase.php, line 16

Namespace

Drupal\groupmedia\Plugin\MediaFinder

class TextFieldEmbedBase extends MediaFinderBase {

  /**
   * The entity repository service.
   *
   * @var \Drupal\Core\Entity\EntityRepositoryInterface
   */
  protected $entityRepository;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    $instance->entityRepository = $container
      ->get('entity.repository');
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public function parseEntitiesFromText($text) {
    $dom = Html::load($text);
    $xpath = new \DOMXPath($dom);
    $entities = [];
    foreach ($xpath
      ->query('//' . $this->pluginDefinition['element'] . '[@data-entity-type="media" and @data-entity-uuid]') as $node) {
      $entities[] = $node
        ->getAttribute('data-entity-uuid');
    }
    return $entities;
  }

  /**
   * {@inheritdoc}
   */
  public function getTargetEntities(FieldItemInterface $item) {
    $item_value = $item
      ->getValue();
    if (empty($item_value['value'])) {
      return [];
    }
    $text = $item_value['value'];
    if ($item
      ->getFieldDefinition()
      ->getType() === 'text_with_summary') {
      $text .= $item_value['summary'];
    }
    $entities_in_text = $this
      ->parseEntitiesFromText($text);
    $valid_entities = [];
    foreach ($entities_in_text as $uuid) {

      // Check if the target entity exists since text fields are not
      // automatically updated when an entity is removed.

      /** @var \Drupal\media\MediaInterface $target_entity */
      if ($target_entity = $this->entityRepository
        ->loadEntityByUuid('media', $uuid)) {
        if ($target_entity && $this
          ->shouldBeAdded($target_entity, $item
          ->getEntity(), $item
          ->getFieldDefinition()
          ->getName())) {
          $valid_entities[$target_entity
            ->id()] = $target_entity;
        }
      }
    }
    return $valid_entities;
  }

  /**
   * {@inheritdoc}
   */
  public function process(EntityInterface $entity) {
    $items = [];
    if ($entity instanceof ContentEntityInterface) {

      // Loop through all fields on the entity.
      foreach ($entity
        ->getFieldDefinitions() as $key => $field) {

        // Check if the field is an entity reference, referencing media entities,
        // and retriever the media entity.
        if (in_array($field
          ->getType(), $this
          ->getApplicableFieldTypes()) && !$entity
          ->get($key)
          ->isEmpty()) {
          foreach ($entity
            ->get($key)
            ->getIterator() as $item) {
            $media_entities = $this
              ->getTargetEntities($item);
            $items = array_merge($items, $media_entities);
          }
        }
      }
    }
    return $items;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MediaFinderBase::$moduleHandler	protected	property	The module handler service.
MediaFinderBase::applies	public	function	Checks if the plugin can be applied. Overrides MediaFinderInterface::applies
MediaFinderBase::getApplicableFieldTypes	public	function	Returns the field types this plugin is capable of tracking. Overrides MediaFinderInterface::getApplicableFieldTypes
MediaFinderBase::shouldBeAdded	public	function	Checks whether media item should be considered as group content. Overrides MediaFinderInterface::shouldBeAdded
MediaFinderBase::__construct	public	function	MediaFinderBase constructor. Overrides PluginBase::__construct
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TextFieldEmbedBase::$entityRepository	protected	property	The entity repository service.
TextFieldEmbedBase::create	public static	function	Creates an instance of the plugin. Overrides MediaFinderBase::create
TextFieldEmbedBase::getTargetEntities	public	function
TextFieldEmbedBase::parseEntitiesFromText	public	function
TextFieldEmbedBase::process	public	function	Search for the attached media entities. Overrides MediaFinderInterface::process