cms_content_sync-3.0.x-dev/src/Plugin/cms_content_sync/field_handler/DefaultUserReferenceHandler.php

<?php

namespace Drupal\cms_content_sync\Plugin\cms_content_sync\field_handler;

use Drupal\cms_content_sync\PullIntent;
use Drupal\cms_content_sync\PushIntent;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Field\FieldDefinitionInterface;
use Drupal\Core\Field\FieldStorageDefinitionInterface;
use Drupal\user\Entity\User;
use EdgeBox\SyncCore\Interfaces\Configuration\IDefineEntityType;
use EdgeBox\SyncCore\V2\Raw\Model\RemoteEntityTypePropertyFormat;

/**
 * Providing a minimalistic implementation for any field type.
 *
 * @FieldHandler(
 *   id = "cms_content_sync_default_user_reference_handler",
 *   label = @Translation("Default User Reference"),
 *   weight = 80
 * )
 */
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}
   */
  public function definePropertyAtType(IDefineEntityType $type_definition) {
    $property = $type_definition->addObjectProperty($this->fieldName, $this->fieldDefinition->getLabel(), TRUE, $this->fieldDefinition->isRequired(), $this->fieldDefinition->getType());
    $property
      ->addStringProperty(self::IDENTIFICATION_EMAIL, 'Email', FALSE, FALSE, 'string')
      ->setFormat(RemoteEntityTypePropertyFormat::EMAIL_ADDRESS);
    $property
      ->addStringProperty(self::IDENTIFICATION_NAME, 'Name', FALSE, FALSE, 'string');

    $this->applyPropertySettings($property);

    return $property;
  }

  /**
   * {@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]]);

    if (empty($entities)) {
      $uid = \Drupal::service('keyvalue.database')->get('cms_content_sync_user')->get('uid');

      return User::load($uid);
    }

    return reset($entities);
  }

  /**
   * {@inheritDoc}
   */
  protected function getFallbackReference() {
    // Return special anonymous user for required user reference fields.
    return User::load(0);
  }

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

}