class EntityReferenceFieldItemNormalizer in Drupal 8

Adds the file URI to embedded file entities.

Hierarchy

• class \Drupal\serialization\Normalizer\NormalizerBase implements \Symfony\Component\Serializer\SerializerAwareInterface, CacheableNormalizerInterface uses \Symfony\Component\Serializer\SerializerAwareTrait
  • class \Drupal\serialization\Normalizer\ComplexDataNormalizer
    • class \Drupal\serialization\Normalizer\FieldItemNormalizer implements \Symfony\Component\Serializer\Normalizer\DenormalizerInterface uses FieldableEntityNormalizerTrait, SerializedColumnNormalizerTrait
      • class \Drupal\serialization\Normalizer\EntityReferenceFieldItemNormalizer uses EntityReferenceFieldItemNormalizerTrait

1 file declares its use of EntityReferenceFieldItemNormalizer

EntityReferenceFieldItemNormalizerTest.php in core/modules/serialization/tests/src/Unit/Normalizer/EntityReferenceFieldItemNormalizerTest.php

1 string reference to 'EntityReferenceFieldItemNormalizer'

serialization.services.yml in core/modules/serialization/serialization.services.yml

core/modules/serialization/serialization.services.yml

1 service uses EntityReferenceFieldItemNormalizer

serializer.normalizer.entity_reference_field_item in core/modules/serialization/serialization.services.yml

Drupal\serialization\Normalizer\EntityReferenceFieldItemNormalizer

File

core/modules/serialization/src/Normalizer/EntityReferenceFieldItemNormalizer.php, line 13

Namespace

Drupal\serialization\Normalizer

class EntityReferenceFieldItemNormalizer extends FieldItemNormalizer {
  use EntityReferenceFieldItemNormalizerTrait;

  /**
   * {@inheritdoc}
   */
  protected $supportedInterfaceOrClass = EntityReferenceItem::class;

  /**
   * The entity repository.
   *
   * @var \Drupal\Core\Entity\EntityRepositoryInterface
   */
  protected $entityRepository;

  /**
   * Constructs a EntityReferenceFieldItemNormalizer object.
   *
   * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
   *   The entity repository.
   */
  public function __construct(EntityRepositoryInterface $entity_repository) {
    $this->entityRepository = $entity_repository;
  }

  /**
   * {@inheritdoc}
   */
  public function normalize($field_item, $format = NULL, array $context = []) {
    $values = parent::normalize($field_item, $format, $context);
    $this
      ->normalizeRootReferenceValue($values, $field_item);

    /** @var \Drupal\Core\Entity\EntityInterface $entity */
    if ($entity = $field_item
      ->get('entity')
      ->getValue()) {
      $values['target_type'] = $entity
        ->getEntityTypeId();

      // Add the target entity UUID to the normalized output values.
      $values['target_uuid'] = $entity
        ->uuid();

      // Add a 'url' value if there is a reference and a canonical URL. Hard
      // code 'canonical' here as config entities override the default $rel
      // parameter value to 'edit-form.
      if ($entity
        ->hasLinkTemplate('canonical') && !$entity
        ->isNew() && ($url = $entity
        ->toUrl('canonical')
        ->toString(TRUE))) {
        $this
          ->addCacheableDependency($context, $url);
        $values['url'] = $url
          ->getGeneratedUrl();
      }
      elseif ($entity
        ->getEntityTypeId() === 'file') {
        $values['url'] = file_create_url($entity
          ->getFileUri());
      }
    }
    return $values;
  }

  /**
   * {@inheritdoc}
   */
  protected function constructValue($data, $context) {
    if (isset($data['target_uuid'])) {

      /** @var \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem $field_item */
      $field_item = $context['target_instance'];
      if (empty($data['target_uuid'])) {
        throw new InvalidArgumentException(sprintf('If provided "target_uuid" cannot be empty for field "%s".', $data['target_type'], $data['target_uuid'], $field_item
          ->getName()));
      }
      $target_type = $field_item
        ->getFieldDefinition()
        ->getSetting('target_type');
      if (!empty($data['target_type']) && $target_type !== $data['target_type']) {
        throw new UnexpectedValueException(sprintf('The field "%s" property "target_type" must be set to "%s" or omitted.', $field_item
          ->getFieldDefinition()
          ->getName(), $target_type));
      }
      if ($entity = $this->entityRepository
        ->loadEntityByUuid($target_type, $data['target_uuid'])) {
        return [
          'target_id' => $entity
            ->id(),
        ] + array_intersect_key($data, $field_item
          ->getProperties());
      }
      else {

        // Unable to load entity by uuid.
        throw new InvalidArgumentException(sprintf('No "%s" entity found with UUID "%s" for field "%s".', $data['target_type'], $data['target_uuid'], $field_item
          ->getName()));
      }
    }
    return parent::constructValue($data, $context);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY		constant	Name of key for bubbling cacheability metadata via serialization context.
EntityReferenceFieldItemNormalizer::$entityRepository	protected	property	The entity repository.
EntityReferenceFieldItemNormalizer::$supportedInterfaceOrClass	protected	property	The interface or class that this Normalizer supports. Overrides FieldItemNormalizer::$supportedInterfaceOrClass
EntityReferenceFieldItemNormalizer::constructValue	protected	function	Build the field item value using the incoming data. Overrides FieldableEntityNormalizerTrait::constructValue
EntityReferenceFieldItemNormalizer::normalize	public	function	Normalizes an object into a set of arrays/scalars. Overrides ComplexDataNormalizer::normalize
EntityReferenceFieldItemNormalizer::__construct	public	function	Constructs a EntityReferenceFieldItemNormalizer object.
EntityReferenceFieldItemNormalizerTrait::fieldItemReferencesTaxonomyTerm	protected	function	Determines if a field item references a taxonomy term.
EntityReferenceFieldItemNormalizerTrait::normalizeRootReferenceValue	protected	function
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::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.
FieldItemNormalizer::denormalize	public	function	Denormalizes data back into an object of the given class.
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	Checks whether the given class is supported for normalization by this normalizer.	1
SerializedColumnNormalizerTrait::checkForSerializedStrings	protected	function	Checks if there is a serialized string for a column.
SerializedColumnNormalizerTrait::dataHasStringForSerializeColumn	protected	function	Checks if the data contains string value for serialize column.
SerializedColumnNormalizerTrait::getCustomSerializedPropertyNames	protected	function	Gets the names of all properties the plugin treats as serialized data.
SerializedColumnNormalizerTrait::getSerializedPropertyNames	protected	function	Gets the names of all serialized properties.