class DataNormalizer

Same name in other branches
  1. 9 core/modules/jsonapi/src/Normalizer/DataNormalizer.php \Drupal\jsonapi\Normalizer\DataNormalizer
  2. 8.9.x core/modules/jsonapi/src/Normalizer/DataNormalizer.php \Drupal\jsonapi\Normalizer\DataNormalizer
  3. 11.x core/modules/jsonapi/src/Normalizer/DataNormalizer.php \Drupal\jsonapi\Normalizer\DataNormalizer

Normalizes JSON:API Data objects.

@internal

Hierarchy

Expanded class hierarchy of DataNormalizer

1 string reference to 'DataNormalizer'
jsonapi.services.yml in core/modules/jsonapi/jsonapi.services.yml
core/modules/jsonapi/jsonapi.services.yml
1 service uses DataNormalizer
serializer.normalizer.data.jsonapi in core/modules/jsonapi/jsonapi.services.yml
Drupal\jsonapi\Normalizer\DataNormalizer

File

core/modules/jsonapi/src/Normalizer/DataNormalizer.php, line 13

Namespace

Drupal\jsonapi\Normalizer
View source 
class DataNormalizer extends NormalizerBase {
    
    /**
     * {@inheritdoc}
     */
    public function normalize($object, $format = NULL, array $context = []) : array|string|int|float|bool|\ArrayObject|null {
        assert($object instanceof Data);
        $cacheable_normalizations = array_map(function ($resource) use ($format, $context) {
            return $this->serializer
                ->normalize($resource, $format, $context);
        }, $object->toArray());
        return $object->getCardinality() === 1 ? array_shift($cacheable_normalizations) ?: CacheableNormalization::permanent(NULL) : CacheableNormalization::aggregate($cacheable_normalizations);
    }
    
    /**
     * {@inheritdoc}
     */
    public function hasCacheableSupportsMethod() : bool {
        @trigger_error(__METHOD__ . '() is deprecated in drupal:10.1.0 and is removed from drupal:11.0.0. Use getSupportedTypes() instead. See https://www.drupal.org/node/3359695', E_USER_DEPRECATED);
        return TRUE;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getSupportedTypes(?string $format) : array {
        return [
            Data::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.
DataNormalizer::getSupportedTypes public function Overrides NormalizerBase::getSupportedTypes
DataNormalizer::hasCacheableSupportsMethod public function Overrides NormalizerBase::hasCacheableSupportsMethod
DataNormalizer::normalize public function
NormalizerBase::$format protected property List of formats which supports (de-)normalization. Overrides NormalizerBase::$format
NormalizerBase::addCacheableDependency protected function Adds cacheability if applicable.
NormalizerBase::checkFormat protected function Checks if the provided format is supported by this normalizer. Overrides NormalizerBase::checkFormat
NormalizerBase::rasterizeValueRecursive protected static function Rasterizes a value recursively.
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.