namespace Drupal\hal\Normalizer;
+use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Entity\FieldableEntityInterface;
+use Drupal\Core\Field\FieldItemInterface;
+use Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem;
use Drupal\hal\LinkManager\LinkManagerInterface;
use Drupal\serialization\EntityResolver\EntityResolverInterface;
use Drupal\serialization\EntityResolver\UuidReferenceInterface;
+use Drupal\serialization\Normalizer\EntityReferenceFieldItemNormalizerTrait;
/**
* Converts the Drupal entity reference item object to HAL array structure.
*/
class EntityReferenceItemNormalizer extends FieldItemNormalizer implements UuidReferenceInterface {
+ use EntityReferenceFieldItemNormalizerTrait;
+
/**
* The interface or class that this Normalizer supports.
*
*/
protected $entityResolver;
+ /**
+ * The entity type manager.
+ *
+ * @var \Drupal\Core\Entity\EntityTypeManagerInterface
+ */
+ protected $entityTypeManager;
+
/**
* Constructs an EntityReferenceItemNormalizer object.
*
* The hypermedia link manager.
* @param \Drupal\serialization\EntityResolver\EntityResolverInterface $entity_Resolver
* The entity resolver.
+ * @param \Drupal\Core\Entity\EntityTypeManagerInterface|null $entity_type_manager
+ * The entity type manager.
*/
- public function __construct(LinkManagerInterface $link_manager, EntityResolverInterface $entity_Resolver) {
+ public function __construct(LinkManagerInterface $link_manager, EntityResolverInterface $entity_Resolver, EntityTypeManagerInterface $entity_type_manager = NULL) {
$this->linkManager = $link_manager;
$this->entityResolver = $entity_Resolver;
+ $this->entityTypeManager = $entity_type_manager ?: \Drupal::service('entity_type.manager');
}
/**
* {@inheritdoc}
*/
public function normalize($field_item, $format = NULL, array $context = []) {
- /** @var $field_item \Drupal\Core\Field\FieldItemInterface */
- $target_entity = $field_item->get('entity')->getValue();
-
- // If this is not a content entity, let the parent implementation handle it,
- // only content entities are supported as embedded resources.
- if (!($target_entity instanceof FieldableEntityInterface)) {
+ // If this is not a fieldable entity, let the parent implementation handle
+ // it, only fieldable entities are supported as embedded resources.
+ if (!$this->targetEntityIsFieldable($field_item)) {
return parent::normalize($field_item, $format, $context);
}
+ /** @var $field_item \Drupal\Core\Field\FieldItemInterface */
+ $target_entity = $field_item->get('entity')->getValue();
+
// If the parent entity passed in a langcode, unset it before normalizing
// the target entity. Otherwise, untranslatable fields of the target entity
// will include the langcode.
];
}
+ /**
+ * Checks whether the referenced entity is of a fieldable entity type.
+ *
+ * @param \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem $item
+ * The reference field item whose target entity needs to be checked.
+ *
+ * @return bool
+ * TRUE when the referenced entity is of a fieldable entity type.
+ */
+ protected function targetEntityIsFieldable(EntityReferenceItem $item) {
+ $target_entity = $item->get('entity')->getValue();
+
+ if ($target_entity !== NULL) {
+ return $target_entity instanceof FieldableEntityInterface;
+ }
+
+ $referencing_entity = $item->getEntity();
+ $target_entity_type_id = $item->getFieldDefinition()->getSetting('target_type');
+
+ // If the entity type is the same as the parent, we can check that. This is
+ // just a shortcut to avoid getting the entity type definition and checking
+ // the class.
+ if ($target_entity_type_id === $referencing_entity->getEntityTypeId()) {
+ return $referencing_entity instanceof FieldableEntityInterface;
+ }
+
+ // Otherwise, we need to get the class for the type.
+ $target_entity_type = $this->entityTypeManager->getDefinition($target_entity_type_id);
+ $target_entity_type_class = $target_entity_type->getClass();
+
+ return is_a($target_entity_type_class, FieldableEntityInterface::class, TRUE);
+ }
+
/**
* {@inheritdoc}
*/
$target_type = $field_definition->getSetting('target_type');
$id = $this->entityResolver->resolve($this, $data, $target_type);
if (isset($id)) {
- return ['target_id' => $id];
+ return ['target_id' => $id] + array_intersect_key($data, $field_item->getProperties());
}
return NULL;
}
+ /**
+ * {@inheritdoc}
+ */
+ protected function normalizedFieldValues(FieldItemInterface $field_item, $format, array $context) {
+ // Normalize root reference values here so we don't need to deal with hal's
+ // nested data structure for field items. This will be called from
+ // \Drupal\hal\Normalizer\FieldItemNormalizer::normalize. Which will only
+ // be called from this class for entities that are not fieldable.
+ $normalized = parent::normalizedFieldValues($field_item, $format, $context);
+
+ $this->normalizeRootReferenceValue($normalized, $field_item);
+
+ return $normalized;
+ }
+
/**
* {@inheritdoc}
*/