class RevisionHandler in Feeds Paragraphs 8

Hierarchy

• class \Drupal\feeds_para_mapper\RevisionHandler uses StringTranslationTrait

1 file declares its use of RevisionHandler

TestRevisionHandler.php in tests/src/Unit/TestRevisionHandler.php

1 string reference to 'RevisionHandler'

feeds_para_mapper.services.yml in ./feeds_para_mapper.services.yml

feeds_para_mapper.services.yml

1 service uses RevisionHandler

feeds_para_mapper.revision_handler in ./feeds_para_mapper.services.yml

Drupal\feeds_para_mapper\RevisionHandler

File

src/RevisionHandler.php, line 14

Namespace

Drupal\feeds_para_mapper

class RevisionHandler {
  use StringTranslationTrait;

  /**
   * @var MessengerInterface
   *   The messenger service.
   */
  private $messenger;

  /**
   * @var Importer
   *   The entity importer service.
   */
  private $importer;

  /**
   * @var EntityInterface
   *   The entity that holds the paragraphs
   */
  private $entity;

  /**
   * RevisionHandler constructor.
   *
   * @param MessengerInterface $messenger
   *    The entity importer service.
   * @param Importer $importer
   *    The entity importer service.
   */
  public function __construct(MessengerInterface $messenger, Importer $importer) {
    $this->messenger = $messenger;
    $this->importer = $importer;
  }

  /**
   * @param EntityInterface $entity
   *   The entity that holds the paragraphs
   *
   * @return bool
   *   TRUE on handling success.
   */
  public function handle(EntityInterface $entity) {
    $this->entity = $entity;
    if (!isset($this->entity->fpm_targets)) {
      return false;
    }
    foreach ($this->entity->fpm_targets as $fieldInstance) {
      $target_info = $fieldInstance
        ->get('target_info');
      $this
        ->checkUpdates($target_info->paragraphs);
    }
    $this
      ->cleanUp($entity->fpm_targets);
    return TRUE;
  }

  /**
   * @param Paragraph[] $updates
   */
  protected function checkUpdates(array $updates) {
    $toUpdate = array_filter($updates, function (Paragraph $update) {
      return !$update
        ->isNew();
    });
    foreach ($toUpdate as $update) {
      $this
        ->createRevision($update);
    }
  }

  /**
   *  Creates a revision.
   *
   * @param Paragraph $paragraph
   */
  protected function createRevision(Paragraph $paragraph) {
    $paragraph
      ->setNewRevision(TRUE);
    $paragraph
      ->isDefaultRevision(TRUE);
    try {
      $paragraph
        ->save();
    } catch (EntityStorageException $e) {
      $this->messenger
        ->addError($this
        ->t("Failed to create revision"));
      $this->messenger
        ->addError($e);
    }

    // @see https://www.drupal.org/project/entity_reference_revisions/issues/2984540
    // until this issue is fixed, we need to manually tell the parent entity to use this revision
    $this
      ->updateParentRevision($paragraph);
  }

  /**
   * Updates the parent target's revision id.
   *
   * @param Paragraph $paragraph
   */
  protected function updateParentRevision(Paragraph $paragraph) {
    $host_field = $paragraph
      ->get('parent_field_name')
      ->getValue()[0]['value'];
    $revision_id = $paragraph
      ->updateLoadedRevisionId()
      ->getRevisionId();
    $parent = $paragraph
      ->getParentEntity();
    $values = $parent
      ->get($host_field)
      ->getValue();
    $message = $this
      ->t("Failed to update host entity");
    foreach ($values as $index => $value) {
      if (isset($value['target_id']) && $value['target_id'] === $paragraph
        ->id()) {
        $value['target_revision_id'] = $revision_id;
        try {
          $parent
            ->get($host_field)
            ->set($index, $value);
        } catch (MissingDataException $e) {
          $this->messenger
            ->addError($message);
          $this->messenger
            ->addError($e);
        }
      }
    }
    try {
      $parent
        ->save();
    } catch (EntityStorageException $e) {
      $this->messenger
        ->addError($message);
      $this->messenger
        ->addError($e);
    }
  }

  /**
   *  Cleans up the entity and its paragraphs before saving the update.
   *
   * @param FieldConfigInterface[] $fields
   */
  protected function cleanUp(array $fields) {

    // Load all attached entities for the target field:
    $loaded = array();
    foreach ($fields as $field_name => $field) {
      $loaded[$field_name] = $this->importer
        ->loadTarget($this->entity, $field);
    }

    // Check for any unused entities:
    foreach ($loaded as $field_name => $attached) {
      $used_entities = $fields[$field_name]
        ->get('target_info')->paragraphs;
      if (count($attached) > count($used_entities)) {
        $this
          ->removeUnused($used_entities, $attached, $fields[$field_name]);
      }
    }
  }

  /**
   * Removes any unused entities.
   *
   * @param Paragraph[] $used_entities
   * @param Paragraph[] $attached
   * @param FieldConfigInterface $field
   */
  protected function removeUnused($used_entities, $attached, $field) {

    // Collect the entities that we should remove:
    $toRemove = array();
    for ($i = 0; $i < count($attached); $i++) {
      if (!isset($used_entities[$i])) {
        $toRemove[$i] = $attached[$i];
      }
    }

    // Check that fields in common are not using any of the entities we intend to remove:
    $targetInfo = $field
      ->get('target_info');
    $in_common_fields = $targetInfo->in_common;
    foreach ($in_common_fields as $in_common_field) {
      foreach ($toRemove as $key => $paragraph) {
        $values = $paragraph
          ->get($in_common_field['name'])
          ->getValue();
        if (count($values)) {
          unset($toRemove[$key]);
        }
      }
    }

    // Remove each paragraph id from its parent entity field value:
    $parent = $attached[0]
      ->getParentEntity();
    $parent_field = $attached[0]
      ->get('parent_field_name')
      ->getValue()[0]['value'];
    $removed = 0;
    foreach ($toRemove as $paragraph) {
      $parent_values = $parent
        ->get($parent_field)
        ->getValue();
      foreach ($parent_values as $index => $parent_value) {
        if (isset($parent_value['target_id']) && $parent_value['target_id'] === $paragraph
          ->id()) {
          $parent
            ->get($parent_field)
            ->removeItem($index);
          $removed++;
        }
      }
    }
    if ($removed > 0) {
      $this
        ->createRevision($parent);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
RevisionHandler::$entity	private	property	The entity that holds the paragraphs
RevisionHandler::$importer	private	property	The entity importer service.
RevisionHandler::$messenger	private	property	The messenger service.
RevisionHandler::checkUpdates	protected	function
RevisionHandler::cleanUp	protected	function	Cleans up the entity and its paragraphs before saving the update.
RevisionHandler::createRevision	protected	function	Creates a revision.
RevisionHandler::handle	public	function
RevisionHandler::removeUnused	protected	function	Removes any unused entities.
RevisionHandler::updateParentRevision	protected	function	Updates the parent target's revision id.
RevisionHandler::__construct	public	function	RevisionHandler constructor.
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.