class TaxonomyTermMatch in Acquia Content Hub 8.2

Class TaxonomyTermMatch.

Matches remote taxonomy terms with an local instances.

@package Drupal\acquia_contenthub_subscriber\EventSubscriber\LoadLocalEntity

Hierarchy

• class \Drupal\acquia_contenthub_subscriber\EventSubscriber\LoadLocalEntity\TaxonomyTermMatch implements \Symfony\Component\EventDispatcher\EventSubscriberInterface

1 string reference to 'TaxonomyTermMatch'

acquia_contenthub_subscriber.services.yml in modules/acquia_contenthub_subscriber/acquia_contenthub_subscriber.services.yml

modules/acquia_contenthub_subscriber/acquia_contenthub_subscriber.services.yml

1 service uses TaxonomyTermMatch

acquia_contenthub_subscriber.load_local_entity.taxonomy_term in modules/acquia_contenthub_subscriber/acquia_contenthub_subscriber.services.yml

Drupal\acquia_contenthub_subscriber\EventSubscriber\LoadLocalEntity\TaxonomyTermMatch

File

modules/acquia_contenthub_subscriber/src/EventSubscriber/LoadLocalEntity/TaxonomyTermMatch.php, line 21

Namespace

Drupal\acquia_contenthub_subscriber\EventSubscriber\LoadLocalEntity

class TaxonomyTermMatch implements EventSubscriberInterface {

  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() {
    return [
      AcquiaContentHubEvents::LOAD_LOCAL_ENTITY => [
        [
          'onLoadLocalEntity',
          7,
        ],
      ],
    ];
  }

  /**
   * Load local terms with the same name, vocabulary and relative parent.
   *
   * @param \Drupal\acquia_contenthub\Event\LoadLocalEntityEvent $event
   *   Data tamper event.
   *
   * @throws \Exception
   */
  public function onLoadLocalEntity(LoadLocalEntityEvent $event) {
    $object = $event
      ->getCdf();
    if (!$this
      ->isSupported($object)) {
      return;
    }
    if ($event
      ->getStack()
      ->hasDependency($object
      ->getUuid())) {
      return;
    }
    $vocabulary_name = $this
      ->getVocabularyName($object);
    $storage = $this
      ->getVocabularyStorage();

    // If the vocabulary doesn't exist, the term couldn't possibly exist.
    if (!($vocabulary = $storage
      ->load($vocabulary_name))) {
      return;
    }
    $parents = $this
      ->extractParentAttribute($object);
    $label = $this
      ->getTermLabel($object);
    foreach ($parents as $parent) {
      $term = $this
        ->findTaxonomyTerm($label, $vocabulary_name, $parent, $event
        ->getStack());
      if (empty($term)) {
        continue;
      }
      $this
        ->addDependency($event, $object, $term);
      $event
        ->setEntity($term);
    }
  }

  /**
   * Checks should object be processed or not.
   *
   * @param \Acquia\ContentHubClient\CDF\CDFObject $cdf_object
   *   CDF Object.
   *
   * @return bool
   *   TRUE if CDF object is taxonomy term.
   */
  protected function isSupported(CDFObject $cdf_object) : bool {
    $type = $cdf_object
      ->getAttribute('entity_type');
    return $type
      ->getValue()[CDFObject::LANGUAGE_UNDETERMINED] === 'taxonomy_term';
  }

  /**
   * Get term label from CDF object.
   *
   * @param \Acquia\ContentHubClient\CDF\CDFObject $cdf_object
   *   CDF object.
   *
   * @return string|null
   *   Term label.
   */
  protected function getTermLabel(CDFObject $cdf_object) : ?string {
    $term_language = $cdf_object
      ->getMetadata()['default_language'];
    $label = $cdf_object
      ->getAttribute('label')
      ->getValue();
    return $label[$term_language] ?? $label[CDFObject::LANGUAGE_UNDETERMINED] ?? NULL;
  }

  /**
   * Extracts vocabulary name from CDF object.
   *
   * @param \Acquia\ContentHubClient\CDF\CDFObject $cdf_object
   *   CDF object.
   *
   * @return string|null
   *   Vocabulary machine name.
   */
  protected function getVocabularyName(CDFObject $cdf_object) : ?string {
    $bundle = $cdf_object
      ->getAttribute('bundle')
      ->getValue();
    return $bundle[CDFObject::LANGUAGE_UNDETERMINED] ?? NULL;
  }

  /**
   * Extracts 'parent' attribute from CDF object.
   *
   * @param \Acquia\ContentHubClient\CDF\CDFObject $object
   *   CDF Object.
   *
   * @return array|null
   *   Attribute value or NULL.
   */
  protected function extractParentAttribute(CDFObject $object) {
    $parent_attribute = $object
      ->getAttribute('parent');
    if (empty($parent_attribute)) {
      return [
        '0',
      ];
    }
    $attribute_value = $parent_attribute
      ->getValue();
    if (empty($attribute_value[CDFObject::LANGUAGE_UNDETERMINED])) {
      return [
        '0',
      ];
    }
    return $attribute_value[CDFObject::LANGUAGE_UNDETERMINED];
  }

  /**
   * Find local taxonomy term.
   *
   * @param string|null $label
   *   Term label.
   * @param string|null $vocabulary
   *   Vocabulary machine name.
   * @param string $parent
   *   Term's parent UUID.
   * @param \Drupal\depcalc\DependencyStack $stack
   *   The Dependency Stack.
   *
   * @return \Drupal\taxonomy\Entity\Term|null
   *   Taxonomy term if exists, NULL otherwise.
   *
   * @throws \Exception
   */
  protected function findTaxonomyTerm(?string $label, ?string $vocabulary, string $parent, DependencyStack $stack) {
    if (!$label || !$vocabulary) {
      return NULL;
    }
    if (Uuid::isValid($parent)) {
      $parent_term = $stack
        ->getDependency($parent);

      // The stack should ALWAYS have a term representing the parent. This
      // could be a local or remote term, but the remote uuid should always
      // retrieve it.
      if (!$parent_term) {
        throw new \Exception(sprintf("Taxonomy term %s could not be found in the dependency stack during DataTamper.", $parent));
      }
      $parent = $parent_term
        ->getId();
    }
    $terms = $this
      ->getTermStorage()
      ->loadByProperties([
      'name' => $label,
      'vid' => $vocabulary,
      'parent' => $parent,
    ]);

    // No local terms were found that match our criteria. This is the normal
    // state of a new import.
    if ($parent && empty($terms)) {
      return NULL;
    }
    return array_shift($terms);
  }

  /**
   * Adds entity as dependency.
   *
   * @param \Drupal\acquia_contenthub\Event\LoadLocalEntityEvent $event
   *   Data tamper event.
   * @param \Acquia\ContentHubClient\CDF\CDFObject $object
   *   The CDF Object representing the remote entity.
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The local entity.
   *
   * @throws \Exception
   */
  protected function addDependency(LoadLocalEntityEvent $event, CDFObject $object, EntityInterface $entity) : void {
    $wrapper = new DependentEntityWrapper($entity);
    $wrapper
      ->setRemoteUuid($object
      ->getUuid());
    $event
      ->getStack()
      ->addDependency($wrapper);
  }

  /**
   * Gets the Vocabulary Storage.
   */
  protected function getVocabularyStorage() {
    return \Drupal::entityTypeManager()
      ->getStorage('taxonomy_vocabulary');
  }

  /**
   * Gets the Taxonomy Term Storage.
   */
  protected function getTermStorage() {
    return \Drupal::entityTypeManager()
      ->getStorage('taxonomy_term');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
TaxonomyTermMatch::addDependency	protected	function	Adds entity as dependency.
TaxonomyTermMatch::extractParentAttribute	protected	function	Extracts 'parent' attribute from CDF object.
TaxonomyTermMatch::findTaxonomyTerm	protected	function	Find local taxonomy term.
TaxonomyTermMatch::getSubscribedEvents	public static	function	Returns an array of event names this subscriber wants to listen to.
TaxonomyTermMatch::getTermLabel	protected	function	Get term label from CDF object.
TaxonomyTermMatch::getTermStorage	protected	function	Gets the Taxonomy Term Storage.
TaxonomyTermMatch::getVocabularyName	protected	function	Extracts vocabulary name from CDF object.
TaxonomyTermMatch::getVocabularyStorage	protected	function	Gets the Vocabulary Storage.
TaxonomyTermMatch::isSupported	protected	function	Checks should object be processed or not.
TaxonomyTermMatch::onLoadLocalEntity	public	function	Load local terms with the same name, vocabulary and relative parent.