class RelationshipNormalizer
Same name and namespace in other branches
- 10 core/modules/jsonapi/src/Normalizer/RelationshipNormalizer.php \Drupal\jsonapi\Normalizer\RelationshipNormalizer
- 11.x core/modules/jsonapi/src/Normalizer/RelationshipNormalizer.php \Drupal\jsonapi\Normalizer\RelationshipNormalizer
- 9 core/modules/jsonapi/src/Normalizer/RelationshipNormalizer.php \Drupal\jsonapi\Normalizer\RelationshipNormalizer
- 8.9.x core/modules/jsonapi/src/Normalizer/RelationshipNormalizer.php \Drupal\jsonapi\Normalizer\RelationshipNormalizer
Normalizes a JSON:API relationship object.
@internal
Hierarchy
- class \Drupal\serialization\Normalizer\NormalizerBase implements \Symfony\Component\Serializer\SerializerAwareInterface, \Drupal\serialization\Normalizer\CacheableNormalizerInterface uses \Symfony\Component\Serializer\SerializerAwareTrait
- class \Drupal\jsonapi\Normalizer\NormalizerBase extends \Drupal\serialization\Normalizer\NormalizerBase
- class \Drupal\jsonapi\Normalizer\RelationshipNormalizer uses \Drupal\serialization\Normalizer\SchematicNormalizerTrait extends \Drupal\jsonapi\Normalizer\NormalizerBase
- class \Drupal\jsonapi\Normalizer\NormalizerBase extends \Drupal\serialization\Normalizer\NormalizerBase
Expanded class hierarchy of RelationshipNormalizer
1 file declares its use of RelationshipNormalizer
- RelationshipNormalizerTest.php in core/
modules/ jsonapi/ tests/ src/ Kernel/ Normalizer/ RelationshipNormalizerTest.php
1 string reference to 'RelationshipNormalizer'
- jsonapi.services.yml in core/
modules/ jsonapi/ jsonapi.services.yml - core/modules/jsonapi/jsonapi.services.yml
1 service uses RelationshipNormalizer
File
-
core/
modules/ jsonapi/ src/ Normalizer/ RelationshipNormalizer.php, line 17
Namespace
Drupal\jsonapi\NormalizerView source
class RelationshipNormalizer extends NormalizerBase {
use SchematicNormalizerTrait;
/**
* Constructor.
*
* @param \Drupal\jsonapi\ResourceType\ResourceTypeRepositoryInterface $resourceTypeRepository
* Resource type repository.
*/
public function __construct(protected ResourceTypeRepositoryInterface $resourceTypeRepository) {
}
/**
* Normalizes data into a set of arrays/scalars.
*
* @param \Drupal\jsonapi\JsonApiResource\Relationship $object
* Data to normalize.
* @param string|null $format
* Format the normalization result will be encoded as.
* @param array<string, mixed> $context
* Context options for the normalizer.
*
* @return array|string|int|float|bool|\ArrayObject<mixed, mixed>|null
* \ArrayObject is used to make sure an empty object is encoded as an
* object not an array.
*/
public function doNormalize($object, $format = NULL, array $context = []) : array|string|int|float|bool|\ArrayObject|null {
assert($object instanceof Relationship);
return CacheableNormalization::aggregate([
'data' => $this->serializer
->normalize($object->getData(), $format, $context),
'links' => $this->serializer
->normalize($object->getLinks(), $format, $context)
->omitIfEmpty(),
'meta' => CacheableNormalization::permanent($object->getMeta())
->omitIfEmpty(),
]);
}
/**
* {@inheritdoc}
*/
public function getNormalizationSchema(mixed $object, array $context = []) : array {
assert($object instanceof Relationship);
$schema = [
'allOf' => [
[
'$ref' => JsonApiSpec::SUPPORTED_SPECIFICATION_JSON_SCHEMA . '#/definitions/relationship',
],
],
];
$field_definition = $object->getContext()
->getField($object->getFieldName())?->getFieldDefinition();
$item_class = $field_definition?->getItemDefinition()->getClass();
assert($item_class, sprintf('The context ResourceObject for Relationship being normalized is missing field %s.', $object->getFieldName()));
if (!$item_class || !is_subclass_of($item_class, EntityReferenceItemInterface::class)) {
return $schema;
}
$targets = $item_class::getReferenceableBundles($field_definition);
$target_types = array_reduce(array_keys($targets), function (array $carry, string $entity_type_id) use ($targets) {
foreach ($targets[$entity_type_id] as $bundle) {
// Even if a resource is internal, it can be referenced.
if (!($resource = $this->resourceTypeRepository
->get($entity_type_id, $bundle)) || in_array($resource->getTypeName(), $carry)) {
continue;
}
$carry[] = $resource->getTypeName();
}
return $carry;
}, []);
if ($target_types) {
$schema['properties']['type'] = [
'oneOf' => array_map(fn(string $resource_type_name) => [
'const' => $resource_type_name,
], $target_types),
];
}
return $schema;
}
/**
* {@inheritdoc}
*/
public function getSupportedTypes(?string $format) : array {
return [
Relationship::class => TRUE,
];
}
}
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. | |||
| JsonSchemaReflectionTrait::getJsonSchemaForMethod | protected | function | Get a JSON Schema based on method reflection. | ||
| NormalizerBase::$format | protected | property | List of formats which supports (de-)normalization. | Overrides NormalizerBase::$format | |
| NormalizerBase::addCacheableDependency | protected | function | Adds cacheability if applicable. | ||
| 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 | ||
| RelationshipNormalizer::doNormalize | public | function | Normalizes data into a set of arrays/scalars. | Overrides SchematicNormalizerTrait::doNormalize | |
| RelationshipNormalizer::getNormalizationSchema | public | function | Retrieve JSON Schema for the normalization. | Overrides SchematicNormalizerTrait::getNormalizationSchema | |
| RelationshipNormalizer::getSupportedTypes | public | function | Overrides NormalizerBase::getSupportedTypes | ||
| RelationshipNormalizer::__construct | public | function | Constructor. | ||
| SchematicNormalizerFallbackTrait::generateNoSchemaAvailableMessage | public static | function | |||
| SchematicNormalizerHelperTrait::checkFormat | protected | function | |||
| SchematicNormalizerTrait::normalize | public | function | Normalizes data into a set of arrays/scalars. | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.