DataNormalizer.php

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

Namespace

Drupal\jsonapi\Normalizer

File

core/modules/jsonapi/src/Normalizer/DataNormalizer.php

View source
<?php

namespace Drupal\jsonapi\Normalizer;

use Drupal\jsonapi\JsonApiResource\Data;
use Drupal\jsonapi\Normalizer\Value\CacheableNormalization;

/**
 * Normalizes JSON:API Data objects.
 *
 * @internal
 */
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,
        ];
    }

}

Classes

Title Deprecated Summary
DataNormalizer Normalizes JSON:API Data objects.

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