class FieldLinkDetector in Lingotek Translation 3.7.x

@RelatedEntitiesDetector ( id = "field_link_detector", title =

Plugin annotation

@Translation("Get editor linked entities with html links"),
  description = @translation("Get editor linked entities with html links."),
  weight = 7,
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\lingotek\Plugin\RelatedEntitiesDetector\FieldLinkDetector implements ContainerFactoryPluginInterface, RelatedEntitiesDetectorInterface

1 file declares its use of FieldLinkDetector

FieldLinkDetectorTest.php in tests/src/Unit/Plugin/RelatedEntitiesDetector/FieldLinkDetectorTest.php

File

src/Plugin/RelatedEntitiesDetector/FieldLinkDetector.php, line 24

Namespace

Drupal\lingotek\Plugin\RelatedEntitiesDetector

class FieldLinkDetector extends PluginBase implements RelatedEntitiesDetectorInterface, ContainerFactoryPluginInterface {

  /**
   * {@inheritdoc}
   */
  protected $fieldTypes = [
    "link",
  ];

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The entity field manager.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * The Lingotek configuration service.
   *
   * @var \Drupal\lingotek\LingotekConfigurationServiceInterface
   */
  protected $lingotekConfiguration;

  /**
   * NestedEntityReferences constructor.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param array $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity manager.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entityFieldManager
   *   The entity field manager.
   * @param \Drupal\lingotek\LingotekConfigurationServiceInterface $lingotekConfiguration
   *   The Lingotek configuration service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entityTypeManager, EntityFieldManagerInterface $entityFieldManager, LingotekConfigurationServiceInterface $lingotekConfiguration) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entityTypeManager;
    $this->entityFieldManager = $entityFieldManager;
    $this->lingotekConfiguration = $lingotekConfiguration;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'), $container
      ->get('entity_field.manager'), $container
      ->get('lingotek.configuration'));
  }

  /**
   * {@inheritdoc}
   */
  public function extract(ContentEntityInterface &$entity, array &$entities, array &$related, $depth, array $visited) {
    $visited[$entity
      ->bundle()][] = $entity
      ->id();
    $entities[$entity
      ->getEntityTypeId()][$entity
      ->id()] = $entity
      ->getUntranslated();
    if ($depth > 0) {
      --$depth;
      $field_definitions = $this->entityFieldManager
        ->getFieldDefinitions($entity
        ->getEntityTypeId(), $entity
        ->bundle());
      foreach ($field_definitions as $k => $definition) {
        $field_type = $field_definitions[$k]
          ->getType();
        if (in_array($field_type, $this->fieldTypes)) {
          foreach ($entity
            ->get($k) as $item) {
            $target = $this
              ->getTargetEntities($item);
            if (!empty($target)) {
              [
                $target_entity_type_id,
                $target_id,
              ] = $target;
              $target_entity_type = $this->entityTypeManager
                ->getDefinition($target_entity_type_id);
              if ($target_entity_type instanceof ContentEntityType) {
                $referencedEntity = $this->entityTypeManager
                  ->getStorage($target_entity_type_id)
                  ->load($target_id);
                if ($referencedEntity !== NULL) {

                  // We need to avoid cycles if we have several entity references
                  // referencing each other.
                  if (!isset($visited[$referencedEntity
                    ->bundle()]) || !in_array($referencedEntity
                    ->id(), $visited[$referencedEntity
                    ->bundle()])) {
                    if ($referencedEntity instanceof ContentEntityInterface && $referencedEntity
                      ->isTranslatable() && $this->lingotekConfiguration
                      ->isEnabled($referencedEntity
                      ->getEntityTypeId(), $referencedEntity
                      ->bundle())) {
                      if (!$this->lingotekConfiguration
                        ->isFieldLingotekEnabled($entity
                        ->getEntityTypeId(), $entity
                        ->bundle(), $k)) {
                        $entities = $this
                          ->extract($referencedEntity, $entities, $related, $depth, $visited);
                      }
                      else {
                        $related[$referencedEntity
                          ->getEntityTypeId()][$referencedEntity
                          ->id()] = $referencedEntity
                          ->getUntranslated();
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
    return $entities;
  }

  /**
   * Get the target entity of a given link.
   *
   * @param \Drupal\Core\Field\FieldItemInterface $link
   *   The link field item.
   *
   * @return array
   *   Array of (target type, target id). Empty if no entity was linked.
   */
  public function getTargetEntities(FieldItemInterface $link) {

    /** @var \Drupal\link\LinkItemInterface $link */

    // Check if the link is referencing an entity.
    $url = $link
      ->getUrl();
    if (!$url
      ->isRouted() || !preg_match('/^entity\\./', $url
      ->getRouteName())) {
      return [];
    }

    // Ge the target entity type and ID.
    $route_parameters = $url
      ->getRouteParameters();
    $target_type = array_keys($route_parameters)[0];
    $target_id = $route_parameters[$target_type];

    // Only return a valid result if the target entity exists.
    try {
      if (!$this->entityTypeManager
        ->getStorage($target_type)
        ->load($target_id)) {
        return [];
      }
    } catch (\Exception $exception) {
      return [];
    }
    return [
      $target_type,
      $target_id,
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FieldLinkDetector::$entityFieldManager	protected	property	The entity field manager.
FieldLinkDetector::$entityTypeManager	protected	property	The entity type manager.
FieldLinkDetector::$fieldTypes	protected	property
FieldLinkDetector::$lingotekConfiguration	protected	property	The Lingotek configuration service.
FieldLinkDetector::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
FieldLinkDetector::extract	public	function	Extract nested and related content. Overrides RelatedEntitiesDetectorInterface::extract
FieldLinkDetector::getTargetEntities	public	function	Get the target entity of a given link.
FieldLinkDetector::__construct	public	function	NestedEntityReferences constructor. Overrides PluginBase::__construct
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	2
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.