You are here

Home » API reference » CMS Content Sync 2.0.x » MergeableEntityReferenceHandler.php

class MergeableEntityReferenceHandler in CMS Content Sync 2.0.x

Same name and namespace in other branches
  1. 8 src/Plugin/cms_content_sync/field_handler/MergeableEntityReferenceHandler.php \Drupal\cms_content_sync\Plugin\cms_content_sync\field_handler\MergeableEntityReferenceHandler
  2. 2.1.x src/Plugin/cms_content_sync/field_handler/MergeableEntityReferenceHandler.php \Drupal\cms_content_sync\Plugin\cms_content_sync\field_handler\MergeableEntityReferenceHandler

Providing a minimalistic implementation for any field type.

Plugin annotation


@FieldHandler(
  id = "cms_content_sync_mergeable_entity_reference_handler",
  label = @Translation("Default Entity Reference"),
  weight = 90
)

Hierarchy

Expanded class hierarchy of MergeableEntityReferenceHandler

File

src/Plugin/cms_content_sync/field_handler/MergeableEntityReferenceHandler.php, line 20

Namespace

Drupal\cms_content_sync\Plugin\cms_content_sync\field_handler
View source 
class MergeableEntityReferenceHandler extends DefaultEntityReferenceHandler {

  /**
   * {@inheritdoc}
   */
  public static function supports($entity_type, $bundle, $field_name, FieldDefinitionInterface $field) {
    return false;
  }

  /**
   * {@inheritdoc}
   */
  public function getHandlerSettings($current_values, $type = 'both') {
    $options = [];
    if ($this->fieldDefinition
      ->getFieldStorageDefinition()
      ->isMultiple() && 'push' !== $type) {
      $options['merge_local_changes'] = [
        '#type' => 'checkbox',
        '#title' => 'Merge local changes',
        '#default_value' => isset($current_values['merge_local_changes']) ? $current_values['merge_local_changes'] : false,
      ];
    }
    return array_merge(parent::getHandlerSettings($current_values, $type), $options);
  }
  protected function setValues(PullIntent $intent) {

    /**
     * @var \Drupal\Core\Entity\FieldableEntityInterface $entity
     */
    $entity = $intent
      ->getEntity();
    $entityTypeManager = \Drupal::entityTypeManager();

    // Since this is only used for paragraphs, there is only one entity type
    // existent.
    $reference_type = $this
      ->getReferencedEntityTypes()[0];
    $storage = $entityTypeManager
      ->getStorage($reference_type);
    $data = $intent
      ->getProperty($this->fieldName);
    $merge = !empty($this->settings['handler_settings']['merge_local_changes']);
    if (!$merge && $intent
      ->shouldMergeChanges()) {
      return false;
    }
    if (empty($data) && !$merge) {
      $entity
        ->set($this->fieldName, null);
      return true;
    }
    if (!$merge) {
      return parent::setValues($intent);
    }
    if (null === $data) {
      $data = [];
    }
    $reference_ids = [];
    $ids = [];
    foreach ($data as $value) {
      $reference = $intent
        ->loadEmbeddedEntity($value);
      if ($reference) {
        $reference_data = [
          'target_id' => $reference
            ->id(),
        ];
        $ids[] = $reference
          ->id();
        if ($reference instanceof RevisionableInterface) {
          $reference_data['target_revision_id'] = $reference
            ->getRevisionId();
        }
        $reference_ids[] = $reference_data;
      }
    }
    $overwrite_ids = $reference_ids;
    if ($merge && $intent
      ->shouldMergeChanges()) {
      $last_overwrite_values = $intent
        ->getStatusData([
        'field',
        $this->fieldName,
        'last_overwrite_values',
      ]);
      $last_pull_order = $intent
        ->getStatusData([
        'field',
        $this->fieldName,
        'last_imported_values',
      ]);
      $previous = $entity
        ->get($this->fieldName)
        ->getValue();
      $previous_ids = [];
      $previous_id_to_definition = [];
      foreach ($previous as $value) {
        if (empty($value['target_id'])) {
          continue;
        }
        $previous_id_to_definition[$value['target_id']] = $value;
        $previous_ids[] = $value['target_id'];
      }

      // Check if there actually are any local overrides => otherwise just
      // overwrite local references with new references and new order.
      if (!is_null($last_pull_order)) {
        $merged = [];
        $merged_ids = [];

        // First add all existing entities to the new value (merged items)
        foreach ($previous_ids as $target_id) {
          $reference = $storage
            ->load($target_id);
          if (!$reference) {
            continue;
          }

          // Removed from remote => remove locally.
          if (!in_array($target_id, $ids)) {
            $info = EntityStatus::getInfoForEntity($reference
              ->getEntityTypeId(), $reference
              ->uuid(), $intent
              ->getFlow(), $intent
              ->getPool());

            // But only if it was actually pulled.
            if ($info && !$info
              ->isSourceEntity()) {
              continue;
            }
          }
          $merged[] = $previous_id_to_definition[$target_id];
          $merged_ids[] = $target_id;
        }

        // Next add all newly added items where they fit best.
        if (count($reference_ids)) {
          for ($i = 0; $i < count($reference_ids); ++$i) {
            $def = $reference_ids[$i];
            $id = $def['target_id'];

            // Already present? Ignore.
            if (in_array($id, $merged_ids)) {
              continue;
            }

            // Deleted locally? Ignore.
            if (in_array($def, $last_overwrite_values)) {
              continue;
            }

            // Get the index of the item before this one, so we can add ours
            // after it. If this doesn't work, it will be the first item
            // in the new item set.
            $n = $i - 1;
            $index = false;
            while (false === $index && $n >= 0) {
              $index = array_search($reference_ids[$n]['target_id'], $merged_ids);
              --$n;
            }

            // First and unfound come first.
            if (0 === $i || false === $index) {
              array_unshift($merged, $def);
              array_unshift($merged_ids, $id);
              continue;
            }

            // Everything else comes behind the last item that exists.
            array_splice($merged, $index + 1, 0, [
              $def,
            ]);
            array_splice($merged_ids, $index + 1, 0, $id);
          }
        }
        $reference_ids = $merged;
        $ids = $merged_ids;
      }
    }
    if ('paragraph' == $this->fieldDefinition
      ->getSetting('target_type')) {
      foreach ($reference_ids as $def) {
        $paragraph = Paragraph::load($def['target_id']);
        if (!$paragraph
          ->getParentEntity()) {

          /**
           * @var \Drupal\Core\Entity\ContentEntityInterface $entity
           */
          $paragraph
            ->setParentEntity($entity, $this->fieldName);
        }
      }
    }
    if (!$merge || !$intent
      ->shouldMergeChanges() || $overwrite_ids !== $last_overwrite_values) {
      $entity
        ->set($this->fieldName, count($reference_ids) ? $reference_ids : null);
      $intent
        ->setStatusData([
        'field',
        $this->fieldName,
        'last_imported_values',
      ], $ids);
      $intent
        ->setStatusData([
        'field',
        $this->fieldName,
        'last_overwrite_values',
      ], $overwrite_ids);
    }
    return true;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DefaultEntityReferenceHandler::allowSubscribeFilter protected function Overrides EntityReferenceHandlerBase::allowSubscribeFilter
DefaultEntityReferenceHandler::definePropertyAtType public function Provide the Sync Core with the right property definition so this field can be stored and synchronized. Overrides FieldHandlerBase::definePropertyAtType 1
DefaultEntityReferenceHandler::getInvalidSubfields protected function Get a list of array keys from $entity->field_* values that should be ignored (unset before push). Overrides EntityReferenceHandlerBase::getInvalidSubfields 1
DefaultEntityReferenceHandler::saveEmbeddedPushToPools public static function Save the push settings the user selected for paragraphs.
DefaultEntityReferenceHandler::SUPPORTED_CONFIG_ENTITY_TYPES public constant
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
EntityReferenceHandlerBase::allowPushingReferencedEntities protected function 1
EntityReferenceHandlerBase::forceEmbeddingReferencedEntities protected function Don't expose option, but force push. 2
EntityReferenceHandlerBase::forcePushingReferencedEntities protected function Don't expose option, but force push. 3
EntityReferenceHandlerBase::getFieldValuesForReference protected function Get the values to be set to the $entity->field_*. 3
EntityReferenceHandlerBase::getReferencedEntityTypes protected function 3
EntityReferenceHandlerBase::getReferencedEntityTypesFromFieldDefinition public static function
EntityReferenceHandlerBase::loadReferencedEntity protected function Load the entity that is either referenced or embedded by $definition. 2
EntityReferenceHandlerBase::loadReferencedEntityFromFieldValue protected function Load the referenced entity, given the $entity->field_* value. 2
EntityReferenceHandlerBase::pull public function Overrides FieldHandlerBase::pull
EntityReferenceHandlerBase::push public function Overrides FieldHandlerBase::push
EntityReferenceHandlerBase::serializeReference protected function 2
EntityReferenceHandlerBase::shouldEmbedReferencedEntities protected function Check if referenced entities should be embedded automatically.
EntityReferenceHandlerBase::shouldPushReferencedEntities protected function Check if referenced entities should be pushed automatically.
EntityReferenceHandlerBase::validateHandlerSettings public function Validate the settings defined above. $form and $form_state are the same as in the Form API. $settings_key is the index at $form['sync_entities'] for this handler instance. Overrides FieldHandlerBase::validateHandlerSettings
FieldHandlerBase::$bundleName protected property
FieldHandlerBase::$entityTypeName protected property
FieldHandlerBase::$fieldDefinition protected property
FieldHandlerBase::$fieldName protected property
FieldHandlerBase::$flow protected property
FieldHandlerBase::$logger protected property A logger instance.
FieldHandlerBase::$settings protected property Additional settings as provided by {
FieldHandlerBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
FieldHandlerBase::forceMergeOverwrite protected function 1
FieldHandlerBase::getAllowedPullOptions public function Get the allowed pull options. Overrides FieldHandlerInterface::getAllowedPullOptions
FieldHandlerBase::getAllowedPushOptions public function Get the allowed push options. Overrides FieldHandlerInterface::getAllowedPushOptions
FieldHandlerBase::getFieldName public function Overrides FieldHandlerInterface::getFieldName
FieldHandlerBase::__construct public function Constructs a Drupal\rest\Plugin\ResourceBase object. Overrides PluginBase::__construct
MergeableEntityReferenceHandler::getHandlerSettings public function Get the handler settings. Overrides EntityReferenceHandlerBase::getHandlerSettings
MergeableEntityReferenceHandler::setValues protected function Overrides EntityReferenceHandlerBase::setValues
MergeableEntityReferenceHandler::supports public static function Check if this handler supports the given field instance. Overrides DefaultEntityReferenceHandler::supports 1
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 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.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.