class MenuLinkContentNormalizer in Better Normalizers 8

A normalizer to handle menu-link content links to entities.

Hierarchy

class \Drupal\serialization\Normalizer\NormalizerBase implements \Symfony\Component\Serializer\SerializerAwareInterface, CacheableNormalizerInterface uses \Symfony\Component\Serializer\SerializerAwareTrait
- class \Drupal\hal\Normalizer\NormalizerBase implements \Symfony\Component\Serializer\Normalizer\DenormalizerInterface
  - class \Drupal\hal\Normalizer\ContentEntityNormalizer uses DeprecatedServicePropertyTrait, FieldableEntityNormalizerTrait
    class \Drupal\better_normalizers\Normalizer\MenuLinkContentNormalizer

Expanded class hierarchy of MenuLinkContentNormalizer

1 file declares its use of MenuLinkContentNormalizer

MenuLinkContentNormalizerTest.php in tests/src/Kernel/MenuLinkContentNormalizerTest.php

File

src/Normalizer/MenuLinkContentNormalizer.php, line 20

Namespace

Drupal\better_normalizers\Normalizer

View source

class MenuLinkContentNormalizer extends ContentEntityNormalizer {

  /**
   * Psuedo field name for embedding target entity.
   *
   * @var string
   */
  const PSUEDO_FIELD_NAME = 'menu_link_content_target_entity';

  /**
   * Psuedo field name for embedding parent target entity.
   *
   * @var string
   */
  const PSUEDO_PARENT_FIELD_NAME = 'menu_link_content_parent_entity';

  /**
   * {@inheritdoc}
   */
  protected $supportedInterfaceOrClass = 'Drupal\\menu_link_content\\MenuLinkContentInterface';

  /**
   * UUID Reference resolver.
   *
   * @var \Drupal\serialization\EntityResolver\UuidReferenceInterface
   */
  protected $uuidReference;

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

  /**
   * {@inheritdoc}
   */
  public function __construct(LinkManagerInterface $link_manager, EntityTypeManagerInterface $entity_type_manager, ModuleHandlerInterface $module_handler, EntityTypeRepositoryInterface $entity_type_repository, EntityFieldManagerInterface $entity_field_manager, UuidReferenceInterface $uuid_reference, EntityRepositoryInterface $entity_repository) {
    parent::__construct($link_manager, $entity_type_manager, $module_handler, $entity_type_repository, $entity_field_manager);
    $this->uuidReference = $uuid_reference;
    $this->entityRepository = $entity_repository;
  }

  /**
   * {@inheritdoc}
   */
  public function normalize($entity, $format = NULL, array $context = array()) {
    $normalized = parent::normalize($entity, $format, $context);
    if (isset($normalized['link']) && is_array($normalized['link'])) {
      foreach ($normalized['link'] as $key => $link) {
        try {
          $stub = EntityStub::fromEntityUri($link['uri']);
          try {
            if ($target_entity = $this->entityTypeManager
              ->getStorage($stub
              ->getEntityTypeId())
              ->load($stub
              ->getEntityId())) {
              $normalized = $this
                ->embedEntity($entity, $format, $context, $target_entity, $normalized, self::PSUEDO_FIELD_NAME);
              $normalized['link'][$key] += [
                'target_uuid' => $target_entity
                  ->uuid(),
              ];
            }
            else {

              // Entity ID no longer exists.
              continue;
            }
          } catch (PluginNotFoundException $e) {

            // Entity-type not found.
            continue;
          }
        } catch (\InvalidArgumentException $e) {

          // Not an Entity URI link.
          continue;
        }
      }
    }
    if (isset($normalized['parent']) && is_array($normalized['parent'])) {
      foreach ($normalized['parent'] as $parent) {
        if (strpos($parent['value'], PluginBase::DERIVATIVE_SEPARATOR) !== FALSE) {
          list($plugin_id, $parent_uuid) = explode(PluginBase::DERIVATIVE_SEPARATOR, $parent['value']);
          if ($plugin_id === 'menu_link_content' && ($parent_entity = $this->entityRepository
            ->loadEntityByUuid('menu_link_content', $parent_uuid))) {

            // This entity has a parent menu link entity, we embed it.
            $normalized = $this
              ->embedEntity($entity, $format, $context, $parent_entity, $normalized, self::PSUEDO_PARENT_FIELD_NAME);
          }
        }
      }
    }
    return $normalized;
  }

  /**
   * {@inheritdoc}
   */
  public function denormalize($data, $class, $format = NULL, array $context = array()) {
    if (isset($data['link']) && is_array($data['link'])) {
      foreach ($data['link'] as $key => $link) {
        try {
          $stub = EntityStub::fromEntityUri($link['uri']);
          if (isset($link['target_uuid'])) {
            if ($entity = $this->entityRepository
              ->loadEntityByUuid($stub
              ->getEntityTypeId(), $link['target_uuid'])) {
              $data['link'][$key]['uri'] = 'entity:' . $stub
                ->getEntityTypeId() . '/' . $entity
                ->id();
            }
          }
        } catch (\InvalidArgumentException $e) {
          continue;
        }
      }
    }
    $entity = parent::denormalize($data, $class, $format, $context);
    return $entity;
  }

  /**
   * Embeds an entity in the normalized data.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity being serialized.
   * @param string $format
   *   The serialization format.
   * @param array $context
   *   Serializer context.
   * @param \Drupal\Core\Entity\EntityInterface $target_entity
   *   Entity being embedded.
   * @param array $normalized
   *   Current normalized values.
   * @param string $embedded_field_name
   *   Field name to embed the entity using.
   *
   * @return array
   *   Updated normalized values.
   */
  protected function embedEntity(EntityInterface $entity, $format, array $context, EntityInterface $target_entity, array $normalized, $embedded_field_name) {

    // If the parent entity passed in a langcode, unset it before
    // normalizing the target entity. Otherwise, untranslatable fields
    // of the target entity will include the langcode.
    $langcode = isset($context['langcode']) ? $context['langcode'] : NULL;
    unset($context['langcode']);
    $context['included_fields'] = [
      'uuid',
    ];

    // Normalize the target entity.
    $embedded = $this->serializer
      ->normalize($target_entity, $format, $context);
    $link = $embedded['_links']['self'];

    // If the field is translatable, add the langcode to the link
    // relation object. This does not indicate the language of the
    // target entity.
    if ($langcode) {
      $embedded['lang'] = $link['lang'] = $langcode;
    }

    // The returned structure will be recursively merged into the
    // normalized entity so that the items are properly added to the
    // _links and _embedded objects.
    $embedded_field_uri = $this->linkManager
      ->getRelationUri($entity
      ->getEntityTypeId(), $entity
      ->bundle(), $embedded_field_name, $context);
    $normalized['_links'][$embedded_field_uri] = [
      $link,
    ];
    $normalized['_embedded'][$embedded_field_uri] = [
      $embedded,
    ];
    return $normalized;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY		constant	Name of key for bubbling cacheability metadata via serialization context.
ContentEntityNormalizer::$deprecatedProperties	protected	property
ContentEntityNormalizer::$linkManager	protected	property	The hypermedia link manager.
ContentEntityNormalizer::$moduleHandler	protected	property	The module handler.
ContentEntityNormalizer::getEntityUri	protected	function	Constructs the entity URI.	1
ContentEntityNormalizer::getTypedDataIds	protected	function	Gets the typed data IDs for a type URI.
DeprecatedServicePropertyTrait::__get	public	function	Allows to access deprecated/removed properties.
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::constructValue	protected	function	Build the field item value using the incoming data.	7
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.
MenuLinkContentNormalizer::$entityRepository	protected	property	The entity repository service.
MenuLinkContentNormalizer::$supportedInterfaceOrClass	protected	property	The interface or class that this Normalizer supports. Overrides ContentEntityNormalizer::$supportedInterfaceOrClass
MenuLinkContentNormalizer::$uuidReference	protected	property	UUID Reference resolver.
MenuLinkContentNormalizer::denormalize	public	function	Implements \Symfony\Component\Serializer\Normalizer\DenormalizerInterface::denormalize(). Overrides ContentEntityNormalizer::denormalize
MenuLinkContentNormalizer::embedEntity	protected	function	Embeds an entity in the normalized data.
MenuLinkContentNormalizer::normalize	public	function	Normalizes an object into a set of arrays/scalars. Overrides ContentEntityNormalizer::normalize
MenuLinkContentNormalizer::PSUEDO_FIELD_NAME		constant	Psuedo field name for embedding target entity.
MenuLinkContentNormalizer::PSUEDO_PARENT_FIELD_NAME		constant	Psuedo field name for embedding parent target entity.
MenuLinkContentNormalizer::__construct	public	function	Constructs an ContentEntityNormalizer object. Overrides ContentEntityNormalizer::__construct
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::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

You are here

class MenuLinkContentNormalizer in Better Normalizers 8

Hierarchy

File

Namespace

Members

API Navigation