class EntityNormalizer

Same name in other branches
  1. 9 core/modules/serialization/src/Normalizer/EntityNormalizer.php \Drupal\serialization\Normalizer\EntityNormalizer
  2. 10 core/modules/serialization/src/Normalizer/EntityNormalizer.php \Drupal\serialization\Normalizer\EntityNormalizer
  3. 11.x core/modules/serialization/src/Normalizer/EntityNormalizer.php \Drupal\serialization\Normalizer\EntityNormalizer

Normalizes/denormalizes Drupal entity objects into an array structure.

Hierarchy

Expanded class hierarchy of EntityNormalizer

1 file declares its use of EntityNormalizer
EntityNormalizerTest.php in core/modules/serialization/tests/src/Unit/Normalizer/EntityNormalizerTest.php
1 string reference to 'EntityNormalizer'
serialization.services.yml in core/modules/serialization/serialization.services.yml
core/modules/serialization/serialization.services.yml
1 service uses EntityNormalizer
serializer.normalizer.entity in core/modules/serialization/serialization.services.yml
Drupal\serialization\Normalizer\EntityNormalizer

File

core/modules/serialization/src/Normalizer/EntityNormalizer.php, line 15

Namespace

Drupal\serialization\Normalizer
View source
class EntityNormalizer extends ComplexDataNormalizer implements DenormalizerInterface {
    use FieldableEntityNormalizerTrait;
    
    /**
     * {@inheritdoc}
     */
    protected $supportedInterfaceOrClass = EntityInterface::class;
    
    /**
     * Constructs an EntityNormalizer object.
     *
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager.
     * @param \Drupal\Core\Entity\EntityTypeRepositoryInterface $entity_type_repository
     *   The entity type repository.
     * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
     *   The entity field manager.
     */
    public function __construct(EntityTypeManagerInterface $entity_type_manager, EntityTypeRepositoryInterface $entity_type_repository = NULL, EntityFieldManagerInterface $entity_field_manager = NULL) {
        $this->entityTypeManager = $entity_type_manager;
        if (!$entity_type_repository) {
            @trigger_error('The entity_type.repository service must be passed to EntityNormalizer::__construct(), it is required before Drupal 9.0.0. See https://www.drupal.org/node/2549139.', E_USER_DEPRECATED);
            $entity_type_repository = \Drupal::service('entity_type.repository');
        }
        $this->entityTypeRepository = $entity_type_repository;
        if (!$entity_field_manager) {
            @trigger_error('The entity_field.manager service must be passed to EntityNormalizer::__construct(), it is required before Drupal 9.0.0. See https://www.drupal.org/node/2549139.', E_USER_DEPRECATED);
            $entity_field_manager = \Drupal::service('entity_field.manager');
        }
        $this->entityFieldManager = $entity_field_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    public function denormalize($data, $class, $format = NULL, array $context = []) {
        $entity_type_id = $this->determineEntityTypeId($class, $context);
        $entity_type_definition = $this->getEntityTypeDefinition($entity_type_id);
        // The bundle property will be required to denormalize a bundleable
        // fieldable entity.
        if ($entity_type_definition->entityClassImplements(FieldableEntityInterface::class)) {
            // Extract bundle data to pass into entity creation if the entity type uses
            // bundles.
            if ($entity_type_definition->hasKey('bundle')) {
                // Get an array containing the bundle only. This also remove the bundle
                // key from the $data array.
                $create_params = $this->extractBundleData($data, $entity_type_definition);
            }
            else {
                $create_params = [];
            }
            // Create the entity from bundle data only, then apply field values after.
            $entity = $this->entityTypeManager
                ->getStorage($entity_type_id)
                ->create($create_params);
            $this->denormalizeFieldData($data, $entity, $format, $context);
        }
        else {
            // Create the entity from all data.
            $entity = $this->entityTypeManager
                ->getStorage($entity_type_id)
                ->create($data);
        }
        // Pass the names of the fields whose values can be merged.
        // @todo https://www.drupal.org/node/2456257 remove this.
        $entity->_restSubmittedFields = array_keys($data);
        return $entity;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY constant Name of key for bubbling cacheability metadata via serialization context.
ComplexDataNormalizer::normalize public function 7
EntityNormalizer::$supportedInterfaceOrClass protected property The interface or class that this Normalizer supports. Overrides ComplexDataNormalizer::$supportedInterfaceOrClass 2
EntityNormalizer::denormalize public function 1
EntityNormalizer::__construct public function Constructs an EntityNormalizer object.
FieldableEntityNormalizerTrait::$entityFieldManager protected property The entity field manager.
FieldableEntityNormalizerTrait::$entityTypeManager protected property The entity type manager. 1
FieldableEntityNormalizerTrait::$entityTypeRepository protected property The entity type repository.
FieldableEntityNormalizerTrait::constructValue protected function Build the field item value using the incoming data. 7
FieldableEntityNormalizerTrait::denormalizeFieldData protected function Denormalizes entity data by denormalizing each field individually.
FieldableEntityNormalizerTrait::determineEntityTypeId protected function Determines the entity type ID to denormalize as.
FieldableEntityNormalizerTrait::extractBundleData protected function Denormalizes the bundle property so entity creation can use it.
FieldableEntityNormalizerTrait::getEntityFieldManager protected function Returns the entity field manager.
FieldableEntityNormalizerTrait::getEntityTypeDefinition protected function Gets the entity type definition.
FieldableEntityNormalizerTrait::getEntityTypeManager protected function Returns the entity type manager.
FieldableEntityNormalizerTrait::getEntityTypeRepository protected function Returns the entity type repository.
NormalizerBase::$format protected property List of formats which supports (de-)normalization. 3
NormalizerBase::addCacheableDependency protected function Adds cacheability if applicable.
NormalizerBase::checkFormat protected function Checks if the provided format is supported by this normalizer. 2
NormalizerBase::supportsDenormalization public function Implements \Symfony\Component\Serializer\Normalizer\DenormalizerInterface::supportsDenormalization() 1
NormalizerBase::supportsNormalization public function 1

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.