You are here

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

class DefaultUserReferenceHandler in CMS Content Sync 8

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

Providing a minimalistic implementation for any field type.

Plugin annotation


@FieldHandler(
  id = "cms_content_sync_default_user_reference_handler",
  label = @Translation("Default User Reference"),
  weight = 80
)

Hierarchy

Expanded class hierarchy of DefaultUserReferenceHandler

File

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

Namespace

Drupal\cms_content_sync\Plugin\cms_content_sync\field_handler
View source 
class DefaultUserReferenceHandler extends DefaultEntityReferenceHandler {
  public const IDENTIFICATION_NAME = 'name';
  public const IDENTIFICATION_EMAIL = 'mail';
  public const IDENTIFICATION_SYNC_USER = 'sync_user';

  /**
   * {@inheritdoc}
   */
  public static function supports($entity_type, $bundle, $field_name, FieldDefinitionInterface $field) {
    if (!in_array($field
      ->getType(), [
      'entity_reference',
      'entity_reference_revisions',
    ])) {
      return false;
    }
    $type = $field
      ->getSetting('target_type');
    return 'user' == $type;
  }

  /**
   * {@inheritdoc}
   */
  public function getHandlerSettings($current_values, $type = 'both') {
    return [
      'identification' => [
        '#type' => 'select',
        '#title' => 'Identification',
        '#options' => [
          self::IDENTIFICATION_EMAIL => 'Mail',
          self::IDENTIFICATION_NAME => 'Name',
          self::IDENTIFICATION_SYNC_USER => 'Sync User',
        ],
        '#default_value' => $current_values['identification'] ?? self::IDENTIFICATION_EMAIL,
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function forceMergeOverwrite() {
    return 'revision_uid' == $this->fieldName;
  }

  /**
   * {@inheritdoc}
   */
  protected function loadReferencedEntity(PullIntent $intent, $definition) {
    $property = $this->settings['handler_settings']['identification'];
    if (self::IDENTIFICATION_SYNC_USER == $property) {
      $uid = \Drupal::service('keyvalue.database')
        ->get('cms_content_sync_user')
        ->get('uid');
      return User::load($uid);
    }
    if (empty($definition[$property])) {
      return null;
    }

    /**
     * @var \Drupal\user\Entity\User[] $entities
     */
    $entities = \Drupal::entityTypeManager()
      ->getStorage('user')
      ->loadByProperties([
      $property => $definition[$property],
    ]);
    return reset($entities);
  }

  /**
   * {@inheritdoc}
   */
  protected function serializeReference(PushIntent $intent, EntityInterface $reference, $value) {
    return [
      self::IDENTIFICATION_EMAIL => $reference
        ->get('mail')->value,
      self::IDENTIFICATION_NAME => $reference
        ->get('name')->value,
    ];
  }

}

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
DefaultUserReferenceHandler::forceMergeOverwrite protected function Overrides FieldHandlerBase::forceMergeOverwrite
DefaultUserReferenceHandler::getHandlerSettings public function Get the handler settings. Overrides EntityReferenceHandlerBase::getHandlerSettings
DefaultUserReferenceHandler::IDENTIFICATION_EMAIL public constant
DefaultUserReferenceHandler::IDENTIFICATION_NAME public constant
DefaultUserReferenceHandler::IDENTIFICATION_SYNC_USER public constant
DefaultUserReferenceHandler::loadReferencedEntity protected function Load the entity that is either referenced or embedded by $definition. Overrides EntityReferenceHandlerBase::loadReferencedEntity
DefaultUserReferenceHandler::serializeReference protected function Overrides EntityReferenceHandlerBase::serializeReference
DefaultUserReferenceHandler::supports public static function Check if this handler supports the given field instance. Overrides DefaultEntityReferenceHandler::supports
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::getReferencedEntityTypes protected function 3
EntityReferenceHandlerBase::getReferencedEntityTypesFromFieldDefinition public static function
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::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::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.