class DefaultUserReferenceHandler in CMS Content Sync 2.0.x
Same name and namespace in other branches
- 8 src/Plugin/cms_content_sync/field_handler/DefaultUserReferenceHandler.php \Drupal\cms_content_sync\Plugin\cms_content_sync\field_handler\DefaultUserReferenceHandler
- 2.1.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
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\cms_content_sync\Plugin\FieldHandlerBase implements FieldHandlerInterface, ContainerFactoryPluginInterface
- class \Drupal\cms_content_sync\Plugin\EntityReferenceHandlerBase
- class \Drupal\cms_content_sync\Plugin\cms_content_sync\field_handler\DefaultEntityReferenceHandler
- class \Drupal\cms_content_sync\Plugin\cms_content_sync\field_handler\DefaultUserReferenceHandler
- class \Drupal\cms_content_sync\Plugin\cms_content_sync\field_handler\DefaultEntityReferenceHandler
- class \Drupal\cms_content_sync\Plugin\EntityReferenceHandlerBase
- class \Drupal\cms_content_sync\Plugin\FieldHandlerBase implements FieldHandlerInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of DefaultUserReferenceHandler
File
- src/
Plugin/ cms_content_sync/ field_handler/ DefaultUserReferenceHandler.php, line 21
Namespace
Drupal\cms_content_sync\Plugin\cms_content_sync\field_handlerView 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}
*/
public function definePropertyAtType(IDefineEntityType $type_definition) {
$type_definition
->addObjectProperty($this->fieldName, $this->fieldDefinition
->getLabel(), true, $this->fieldDefinition
->isRequired());
}
/**
* {@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,
];
}
}