You are here

class DefaultFieldCollectionHandler in CMS Content Sync 2.1.x

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

Providing a minimalistic implementation for any field type.

Plugin annotation


@FieldHandler(
  id = "cms_content_sync_default_field_collection_handler",
  label = @Translation("Default Field Collection"),
  weight = 90
)

Hierarchy

Expanded class hierarchy of DefaultFieldCollectionHandler

1 file declares its use of DefaultFieldCollectionHandler
DefaultFieldCollectionItemHandler.php in src/Plugin/cms_content_sync/entity_handler/DefaultFieldCollectionItemHandler.php

File

src/Plugin/cms_content_sync/field_handler/DefaultFieldCollectionHandler.php, line 17

Namespace

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

  /**
   * @var \Drupal\cms_content_sync\Plugin\FieldHandlerInterface
   */
  public static $currentFieldHandler;

  /**
   * @var \Drupal\cms_content_sync\PullIntent
   */
  public static $currentPullIntent;

  /**
   * {@inheritdoc}
   */
  public static function supports($entity_type, $bundle, $field_name, FieldDefinitionInterface $field) {
    if (!in_array($field
      ->getType(), [
      'field_collection',
    ])) {
      return false;
    }
    return true;
  }

  /**
   * {@inheritdoc}
   */
  protected function forceEmbeddingReferencedEntities() {
    return true;
  }

  /**
   * {@inheritdoc}
   */
  protected function getReferencedEntityTypes() {
    return [
      'field_collection_item',
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function loadReferencedEntity(PullIntent $intent, $definition) {
    $previousFieldHandler = self::$currentFieldHandler;
    $previousPullIntent = self::$currentPullIntent;

    // Expose current field and intent (to reference host entity)
    // As field collections require this when being created.
    self::$currentFieldHandler = $this;
    self::$currentPullIntent = $intent;
    $entity = parent::loadReferencedEntity($intent, $definition);
    self::$currentFieldHandler = $previousFieldHandler;
    self::$currentPullIntent = $previousPullIntent;
    return $entity;
  }

  /**
   * {@inheritdoc}
   */
  protected function loadReferencedEntityFromFieldValue($value) {
    if (empty($value['revision_id'])) {
      return null;
    }
    return \Drupal::entityTypeManager()
      ->getStorage('field_collection_item')
      ->loadRevision($value['revision_id']);
  }
  protected function getInvalidSubfields() {
    return [
      '_accessCacheability',
      '_attributes',
      '_loaded',
      'top',
      'target_revision_id',
      'subform',
      'value',
      'revision_id',
    ];
  }

  /**
   * @param $reference
   * @param \Drupal\cms_content_sync\PullIntent $intent
   *
   * @return array
   */
  protected function getFieldValuesForReference($reference, $intent) {
    $entity = $intent
      ->getEntity();
    $reference->host_type = $entity
      ->getEntityTypeId();
    $reference->host_id = $entity
      ->id();
    $reference->host_entity = $entity;
    $reference->field_name = $this->fieldName;
    $reference
      ->save(true);
    return [
      'value' => $reference
        ->id(),
      'revision_id' => $reference
        ->getRevisionId(),
    ];
  }

}

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::saveEmbeddedPushToPools public static function Save the push settings the user selected for paragraphs.
DefaultEntityReferenceHandler::SUPPORTED_CONFIG_ENTITY_TYPES public constant
DefaultFieldCollectionHandler::$currentFieldHandler public static property
DefaultFieldCollectionHandler::$currentPullIntent public static property
DefaultFieldCollectionHandler::forceEmbeddingReferencedEntities protected function Don't expose option, but force push. Overrides EntityReferenceHandlerBase::forceEmbeddingReferencedEntities
DefaultFieldCollectionHandler::getFieldValuesForReference protected function Overrides EntityReferenceHandlerBase::getFieldValuesForReference
DefaultFieldCollectionHandler::getInvalidSubfields protected function Get a list of array keys from $entity->field_* values that should be ignored (unset before push). Overrides DefaultEntityReferenceHandler::getInvalidSubfields
DefaultFieldCollectionHandler::getReferencedEntityTypes protected function Overrides EntityReferenceHandlerBase::getReferencedEntityTypes
DefaultFieldCollectionHandler::loadReferencedEntity protected function Load the entity that is either referenced or embedded by $definition. Overrides EntityReferenceHandlerBase::loadReferencedEntity
DefaultFieldCollectionHandler::loadReferencedEntityFromFieldValue protected function Load the referenced entity, given the $entity->field_* value. Overrides EntityReferenceHandlerBase::loadReferencedEntityFromFieldValue
DefaultFieldCollectionHandler::supports public static function Check if this handler supports the given field instance. Overrides DefaultEntityReferenceHandler::supports
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
EntityReferenceHandlerBase::allowPushingReferencedEntities protected function 1
EntityReferenceHandlerBase::forcePushingReferencedEntities protected function Don't expose option, but force push. 3
EntityReferenceHandlerBase::getHandlerSettings public function Get the handler settings. Overrides FieldHandlerBase::getHandlerSettings 2
EntityReferenceHandlerBase::getReferencedEntityTypesFromFieldDefinition public static function
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. 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. 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.