class ContentEntityNormalizer

Same name in other branches
  1. 9 core/modules/serialization/src/Normalizer/ContentEntityNormalizer.php \Drupal\serialization\Normalizer\ContentEntityNormalizer
  2. 9 core/modules/hal/src/Normalizer/ContentEntityNormalizer.php \Drupal\hal\Normalizer\ContentEntityNormalizer
  3. 8.9.x core/modules/serialization/src/Normalizer/ContentEntityNormalizer.php \Drupal\serialization\Normalizer\ContentEntityNormalizer
  4. 8.9.x core/modules/hal/src/Normalizer/ContentEntityNormalizer.php \Drupal\hal\Normalizer\ContentEntityNormalizer
  5. 11.x core/modules/serialization/src/Normalizer/ContentEntityNormalizer.php \Drupal\serialization\Normalizer\ContentEntityNormalizer

Normalizes/denormalizes Drupal content entities into an array structure.

Hierarchy

Expanded class hierarchy of ContentEntityNormalizer

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

File

core/modules/serialization/src/Normalizer/ContentEntityNormalizer.php, line 11

Namespace

Drupal\serialization\Normalizer
View source 
class ContentEntityNormalizer extends EntityNormalizer {
    
    /**
     * {@inheritdoc}
     */
    public function normalize($entity, $format = NULL, array $context = []) : array|string|int|float|bool|\ArrayObject|null {
        $context += [
            'account' => NULL,
        ];
        $attributes = [];
        
        /** @var \Drupal\Core\Entity\Entity $entity */
        foreach (TypedDataInternalPropertiesHelper::getNonInternalProperties($entity->getTypedData()) as $name => $field_items) {
            if ($field_items->access('view', $context['account'])) {
                $attributes[$name] = $this->serializer
                    ->normalize($field_items, $format, $context);
            }
        }
        return $attributes;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getSupportedTypes(?string $format) : array {
        return [
            ContentEntityInterface::class => TRUE,
        ];
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY constant Name of key for bubbling cacheability metadata via serialization context.
ComplexDataNormalizer::hasCacheableSupportsMethod public function Overrides NormalizerBase::hasCacheableSupportsMethod
ContentEntityNormalizer::getSupportedTypes public function Overrides EntityNormalizer::getSupportedTypes
ContentEntityNormalizer::normalize public function Overrides ComplexDataNormalizer::normalize
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.
FieldableEntityNormalizerTrait::$entityTypeRepository protected property The entity type repository.
FieldableEntityNormalizerTrait::constructValue protected function Build the field item value using the incoming data. 5
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. 1
NormalizerBase::addCacheableDependency protected function Adds cacheability if applicable.
NormalizerBase::checkFormat protected function Checks if the provided format is supported by this normalizer. 1
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.