class ContentEntityNormalizer in Tome 8

Normalizes/denormalizes Drupal content entities into an array structure.

@internal

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\EntityNormalizer implements \Symfony\Component\Serializer\Normalizer\DenormalizerInterface uses FieldableEntityNormalizerTrait
      • class \Drupal\serialization\Normalizer\ContentEntityNormalizer
        • class \Drupal\tome_sync\Normalizer\ContentEntityNormalizer

1 file declares its use of ContentEntityNormalizer

ContentEntityNormalizerTest.php in modules/tome_sync/tests/src/Unit/Normalizer/ContentEntityNormalizerTest.php

1 string reference to 'ContentEntityNormalizer'

tome_sync.services.yml in modules/tome_sync/tome_sync.services.yml

modules/tome_sync/tome_sync.services.yml

1 service uses ContentEntityNormalizer

serializer.normalizer.content_entity_tome_sync in modules/tome_sync/tome_sync.services.yml

Drupal\tome_sync\Normalizer\ContentEntityNormalizer

File

modules/tome_sync/src/Normalizer/ContentEntityNormalizer.php, line 12

Namespace

Drupal\tome_sync\Normalizer

class ContentEntityNormalizer extends BaseContentEntityNormalizer {

  /**
   * Field names that should be excluded from normalization.
   *
   * Should only be used when more generic logic cannot be used.
   *
   * @var array
   */
  protected $fieldDenyList = [
    'metatag',
  ];

  /**
   * Entity type properties that should be excluded from normalization.
   *
   * Should only be used when more generic logic cannot be used.
   *
   * @var array
   */
  protected $entityTypeDenyList = [
    'entity_revision_parent_type_field',
    'entity_revision_parent_id_field',
    'entity_revision_parent_field_name_field',
  ];

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

    /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
    $entity_type = $entity
      ->getEntityType();
    $id_key = $entity_type
      ->getKey('id');

    // User IDs are important to retain to ensure that User 1 is consistent
    // across rebuilds. We unset the ID key otherwise to make merging easier.
    // Imagine fighting over the next Node ID with an upstream repo! Yuck.
    if ($entity_type
      ->id() !== 'user' && $id_key && isset($values[$id_key])) {
      unset($values[$id_key]);
    }
    $id_key = $entity_type
      ->getKey('revision');
    if ($id_key && isset($values[$id_key])) {
      unset($values[$id_key]);
    }
    foreach ($this->fieldDenyList as $field_name) {
      if (isset($values[$field_name])) {
        unset($values[$field_name]);
      }
    }
    foreach ($this->entityTypeDenyList as $key) {
      $field_name = $entity
        ->getEntityType()
        ->get($key);
      if ($field_name && isset($values[$field_name])) {
        unset($values[$field_name]);
      }
    }
    return $values;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY		constant	Name of key for bubbling cacheability metadata via serialization context.
ContentEntityNormalizer::$entityTypeDenyList	protected	property	Entity type properties that should be excluded from normalization.
ContentEntityNormalizer::$fieldDenyList	protected	property	Field names that should be excluded from normalization.
ContentEntityNormalizer::$supportedInterfaceOrClass	protected	property	The interface or class that this Normalizer supports. Overrides EntityNormalizer::$supportedInterfaceOrClass
ContentEntityNormalizer::normalize	public	function	Normalizes an object into a set of arrays/scalars. Overrides ContentEntityNormalizer::normalize	2
EntityNormalizer::denormalize	public	function	Denormalizes data back into an object of the given class.	1
EntityNormalizer::__construct	public	function	Constructs an EntityNormalizer object.
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.
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