View source
<?php
namespace Drupal\jsonapi\Normalizer;
use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Entity\FieldableEntityInterface;
use Drupal\Core\Field\FieldItemInterface;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\TypedData\TypedDataInternalPropertiesHelper;
use Drupal\jsonapi\Normalizer\Value\EntityNormalizerValue;
use Drupal\jsonapi\Normalizer\Value\FieldNormalizerValueInterface;
use Drupal\jsonapi\Normalizer\Value\IncludeOnlyRelationshipNormalizerValue;
use Drupal\jsonapi\Normalizer\Value\NullFieldNormalizerValue;
use Drupal\jsonapi\ResourceType\ResourceType;
use Drupal\jsonapi\LinkManager\LinkManager;
use Drupal\jsonapi\ResourceType\ResourceTypeRepositoryInterface;
use Drupal\serialization\Normalizer\SerializedColumnNormalizerTrait;
use Symfony\Component\HttpKernel\Exception\PreconditionFailedHttpException;
use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
class EntityNormalizer extends NormalizerBase implements DenormalizerInterface {
use SerializedColumnNormalizerTrait;
protected $supportedInterfaceOrClass = ContentEntityInterface::class;
protected $formats = [
'api_json',
];
protected $linkManager;
protected $resourceTypeRepository;
protected $entityTypeManager;
public function __construct(LinkManager $link_manager, ResourceTypeRepositoryInterface $resource_type_repository, EntityTypeManagerInterface $entity_type_manager) {
$this->linkManager = $link_manager;
$this->resourceTypeRepository = $resource_type_repository;
$this->entityTypeManager = $entity_type_manager;
}
public function normalize($entity, $format = NULL, array $context = []) {
$context['resource_type'] = $resource_type = $this->resourceTypeRepository
->get($entity
->getEntityTypeId(), $entity
->bundle());
$resource_type_name = $resource_type
->getTypeName();
$bundle = $resource_type
->getBundle();
if (!empty($context['sparse_fieldset'][$resource_type_name])) {
$field_names = $context['sparse_fieldset'][$resource_type_name];
}
else {
$field_names = $this
->getFieldNames($entity, $bundle, $resource_type);
}
$normalizer_values = [];
$relationship_field_names = array_keys($resource_type
->getRelatableResourceTypes());
foreach ($this
->getFields($entity, $bundle, $resource_type) as $field_name => $field) {
$normalized_field = $this
->serializeField($field, $context, $format);
assert($normalized_field instanceof FieldNormalizerValueInterface);
$in_sparse_fieldset = in_array($field_name, $field_names);
$is_relationship_field = in_array($field_name, $relationship_field_names);
if (!$in_sparse_fieldset) {
if ($is_relationship_field) {
$is_null_field = $field instanceof NullFieldNormalizerValue;
$has_includes = !empty($normalized_field
->getIncludes());
if (!$is_null_field && $has_includes) {
$normalizer_values[$field_name] = new IncludeOnlyRelationshipNormalizerValue($normalized_field);
}
}
continue;
}
$normalizer_values[$field_name] = $normalized_field;
}
$link_context = [
'link_manager' => $this->linkManager,
];
return new EntityNormalizerValue($normalizer_values, $context, $entity, $link_context);
}
public function denormalize($data, $class, $format = NULL, array $context = []) {
if (empty($context['resource_type']) || !$context['resource_type'] instanceof ResourceType) {
throw new PreconditionFailedHttpException('Missing context during denormalization.');
}
$resource_type = $context['resource_type'];
$entity_type_id = $resource_type
->getEntityTypeId();
$bundle = $resource_type
->getBundle();
$bundle_key = $this->entityTypeManager
->getDefinition($entity_type_id)
->getKey('bundle');
if ($bundle_key && $bundle) {
$data[$bundle_key] = $bundle;
}
return $this->entityTypeManager
->getStorage($entity_type_id)
->create($this
->prepareInput($data, $resource_type));
}
protected function getFieldNames($entity, $bundle, ResourceType $resource_type) {
return array_keys($this
->getFields($entity, $bundle, $resource_type));
}
protected function getFields($entity, $bundle, ResourceType $resource_type) {
$output = [];
if (floatval(\Drupal::VERSION) >= 8.5) {
$fields = TypedDataInternalPropertiesHelper::getNonInternalProperties($entity
->getTypedData());
}
else {
$fields = $entity
->getFields();
}
$enabled_field_names = array_filter(array_keys($fields), [
$resource_type,
'isFieldEnabled',
]);
$input = array_intersect_key($fields, array_flip($enabled_field_names));
foreach ($input as $field_name => $field_value) {
$public_field_name = $resource_type
->getPublicName($field_name);
$output[$public_field_name] = $field_value;
}
return $output;
}
protected function serializeField($field, array $context, $format) {
return $this->serializer
->normalize($field, $format, $context);
}
protected function prepareInput(array $data, ResourceType $resource_type) {
$data_internal = [];
foreach ($data as $public_field_name => $field_value) {
if (!$resource_type
->isFieldEnabled($public_field_name)) {
continue;
}
$internal_name = $resource_type
->getInternalName($public_field_name);
if ($resource_type
->getDeserializationTargetClass() instanceof FieldableEntityInterface) {
$is_already_itemized = is_array($field_value) && array_reduce(array_keys($field_value), function ($carry, $index) {
return $carry && is_numeric($index);
}, TRUE);
$itemized_data = $is_already_itemized ? $field_value : [
0 => $field_value,
];
try {
$field_item = $this
->getFieldItemInstance($resource_type, $internal_name);
foreach ($itemized_data as $delta => $field_item_value) {
$this
->checkForSerializedStrings($field_item_value, get_class($field_item), $field_item);
$serialized_property_names = $this
->getCustomSerializedPropertyNames($field_item);
if (is_array($field_item_value)) {
foreach ($serialized_property_names as $serialized_property_name) {
if (!empty($field_item_value[$serialized_property_name])) {
$itemized_data[$delta][$serialized_property_name] = serialize($field_item_value[$serialized_property_name]);
}
}
}
elseif (in_array($field_item
->getDataDefinition()
->getMainPropertyName(), $serialized_property_names, TRUE)) {
$itemized_data[$delta] = serialize($field_item_value);
}
}
} catch (\InvalidArgumentException $e) {
}
$data_internal[$internal_name] = $is_already_itemized ? $itemized_data : $itemized_data[0];
}
else {
$data_internal[$internal_name] = $field_value;
}
}
return $data_internal;
}
protected function getFieldItemInstance(ResourceType $resource_type, $field_name) {
if ($bundle_key = $this->entityTypeManager
->getDefinition($resource_type
->getEntityTypeId())
->getKey('bundle')) {
$create_values = [
$bundle_key => $resource_type
->getBundle(),
];
}
else {
$create_values = [];
}
$entity = $this->entityTypeManager
->getStorage($resource_type
->getEntityTypeId())
->create($create_values);
$field = $entity
->get($field_name);
assert($field instanceof FieldItemListInterface);
$field_item = $field
->appendItem();
assert($field_item instanceof FieldItemInterface);
return $field_item;
}
}