class ConfigEntityNormalizer

Same name and namespace in other branches
  1. 11.x core/modules/serialization/src/Normalizer/ConfigEntityNormalizer.php \Drupal\serialization\Normalizer\ConfigEntityNormalizer

Normalizes/denormalizes Drupal config entity objects into an array structure.

Hierarchy

Expanded class hierarchy of ConfigEntityNormalizer

2 files declare their use of ConfigEntityNormalizer
ConfigEntityNormalizerTest.php in core/modules/serialization/tests/src/Unit/Normalizer/ConfigEntityNormalizerTest.php
LayoutEntityDisplayNormalizer.php in core/modules/layout_builder/src/Normalizer/LayoutEntityDisplayNormalizer.php
1 string reference to 'ConfigEntityNormalizer'
serialization.services.yml in core/modules/serialization/serialization.services.yml
core/modules/serialization/serialization.services.yml
1 service uses ConfigEntityNormalizer
serializer.normalizer.config_entity in core/modules/serialization/serialization.services.yml
Drupal\serialization\Normalizer\ConfigEntityNormalizer

File

core/modules/serialization/src/Normalizer/ConfigEntityNormalizer.php, line 10

Namespace

Drupal\serialization\Normalizer
View source
class ConfigEntityNormalizer extends EntityNormalizer {
  
  /**
   * {@inheritdoc}
   */
  protected $supportedInterfaceOrClass = ConfigEntityInterface::class;
  
  /**
   * {@inheritdoc}
   */
  public function normalize($object, $format = NULL, array $context = []) {
    return static::getDataWithoutInternals($object->toArray());
  }
  
  /**
   * {@inheritdoc}
   */
  public function denormalize($data, $class, $format = NULL, array $context = []) {
    return parent::denormalize(static::getDataWithoutInternals($data), $class, $format, $context);
  }
  
  /**
   * Gets the given data without the internal implementation details.
   *
   * @param array $data
   *   The data that is either currently or about to be stored in configuration.
   *
   * @return array
   *   The same data, but without internals. Currently, that is only the '_core'
   *   key, which is reserved by Drupal core to handle complex edge cases
   *   correctly. Data in the '_core' key is irrelevant to clients reading
   *   configuration, and is not allowed to be set by clients writing
   *   configuration: it is for Drupal core only, and managed by Drupal core.
   *
   * @see https://www.drupal.org/node/2653358
   */
  protected static function getDataWithoutInternals(array $data) {
    return array_diff_key($data, [
      '_core' => TRUE,
    ]);
  }

}

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