You are here

Home » API reference » CMS Content Sync 8 » DefaultEntityReferenceHandler.php

class DefaultEntityReferenceHandler in CMS Content Sync 8

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

Providing a minimalistic implementation for any field type.

Plugin annotation


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

Hierarchy

Expanded class hierarchy of DefaultEntityReferenceHandler

1 file declares its use of DefaultEntityReferenceHandler
cms_content_sync.module in ./cms_content_sync.module
Module file for cms_content_sync.

File

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

Namespace

Drupal\cms_content_sync\Plugin\cms_content_sync\field_handler
View source 
class DefaultEntityReferenceHandler extends EntityReferenceHandlerBase {
  public const SUPPORTED_CONFIG_ENTITY_TYPES = [
    'block',
    'classy_paragraphs_style',
    'view',
  ];

  /**
   * {@inheritdoc}
   */
  public static function supports($entity_type, $bundle, $field_name, FieldDefinitionInterface $field) {
    $supported = [
      'entity_reference',
      'entity_reference_revisions',
      'bibcite_contributor',
      'viewsreference',
      'dynamic_entity_reference',
    ];
    if (!in_array($field
      ->getType(), $supported)) {
      return false;
    }
    $types = EntityReferenceHandlerBase::getReferencedEntityTypesFromFieldDefinition($field);
    foreach ($types as $type) {
      if (in_array($type, [
        'user',
        'brick_type',
        'paragraph',
      ])) {
        return false;
      }
      if ('menu_link' == $field_name) {
        return false;
      }
      $referenced_entity_type = \Drupal::entityTypeManager()
        ->getStorage($type);
      if ($referenced_entity_type instanceof ConfigEntityStorage && !in_array($type, self::SUPPORTED_CONFIG_ENTITY_TYPES)) {
        return false;
      }
    }
    return true;
  }

  /**
   * Save the push settings the user selected for paragraphs.
   *
   * @param null  $parent_entity
   * @param array $tree_position
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public static function saveEmbeddedPushToPools(EntityInterface $entity, $parent_entity = null, $tree_position = []) {

    // Make sure paragraph push settings are saved as well..
    $entityTypeManager = \Drupal::entityTypeManager();
    $entityFieldManager = \Drupal::service('entity_field.manager');

    /** @var \Drupal\Core\Field\FieldDefinitionInterface[] $fields */
    $fields = $entityFieldManager
      ->getFieldDefinitions($entity
      ->getEntityTypeId(), $entity
      ->bundle());
    foreach ($fields as $name => $definition) {
      if ('entity_reference_revisions' == $definition
        ->getType()) {
        $reference_type = $definition
          ->getFieldStorageDefinition()
          ->getPropertyDefinition('entity')
          ->getTargetDefinition()
          ->getEntityTypeId();
        $storage = $entityTypeManager
          ->getStorage($reference_type);
        $data = $entity
          ->get($name)
          ->getValue();
        foreach ($data as $delta => $value) {
          if (empty($value['target_id'])) {
            continue;
          }
          $target_id = $value['target_id'];
          $reference = $storage
            ->load($target_id);
          if (!$reference) {
            continue;
          }

          // In case the values are still present, favor those.
          if (!empty($value['subform']['cms_content_sync_group'])) {
            $set = $value['subform']['cms_content_sync_group'];
            EntityStatus::accessTemporaryPushToPoolInfoForField($entity
              ->getEntityTypeId(), $entity
              ->uuid(), $name, $delta, $tree_position, $set['cms_content_sync_flow'], $set['cms_content_sync_pool'], !empty($set['cms_content_sync_uuid']) ? $set['cms_content_sync_uuid'] : null);
          }
          EntityStatus::saveSelectedPushToPoolForField($entity, $name, $delta, $reference, $tree_position);
          self::saveEmbeddedPushToPools($reference, $entity, array_merge($tree_position, [
            $name,
            $delta,
            'subform',
          ]));
        }
      }
    }
  }

  /**
   * @return bool
   */
  protected function allowSubscribeFilter() {
    $type = $this->fieldDefinition
      ->getSetting('target_type');
    return 'taxonomy_term' == $type;
  }

  /**
   * Get a list of array keys from $entity->field_* values that should be
   * ignored (unset before push).
   *
   * @return array
   */
  protected function getInvalidSubfields() {
    return [
      '_accessCacheability',
      '_attributes',
      '_loaded',
      'top',
      'target_revision_id',
      'subform',
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DefaultEntityReferenceHandler::allowSubscribeFilter protected function Overrides EntityReferenceHandlerBase::allowSubscribeFilter
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
DefaultEntityReferenceHandler::supports public static function Check if this handler supports the given field instance. Overrides FieldHandlerInterface::supports 5
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
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::getHandlerSettings public function Get the handler settings. Overrides FieldHandlerBase::getHandlerSettings 2
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::setValues protected function 1
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
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.