class MarkupNormalizer

Same name and namespace in other branches
  1. 9 core/modules/serialization/src/Normalizer/MarkupNormalizer.php \Drupal\serialization\Normalizer\MarkupNormalizer
  2. 8.9.x core/modules/serialization/src/Normalizer/MarkupNormalizer.php \Drupal\serialization\Normalizer\MarkupNormalizer
  3. 10 core/modules/serialization/src/Normalizer/MarkupNormalizer.php \Drupal\serialization\Normalizer\MarkupNormalizer

Normalizes MarkupInterface objects into a string.

Hierarchy

Expanded class hierarchy of MarkupNormalizer

1 file declares its use of MarkupNormalizer
MarkupNormalizerTest.php in core/modules/serialization/tests/src/Unit/Normalizer/MarkupNormalizerTest.php
1 string reference to 'MarkupNormalizer'
serialization.services.yml in core/modules/serialization/serialization.services.yml
core/modules/serialization/serialization.services.yml
1 service uses MarkupNormalizer
serializer.normalizer.safe_string in core/modules/serialization/serialization.services.yml
Drupal\serialization\Normalizer\MarkupNormalizer

File

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

Namespace

Drupal\serialization\Normalizer
View on git.drupalcode.org
View source 
class MarkupNormalizer extends NormalizerBase {
  use SchematicNormalizerTrait;
  use JsonSchemaReflectionTrait;
  
  /**
   * {@inheritdoc}
   */
  public function doNormalize($object, $format = NULL, array $context = []) : array|string|int|float|bool|\ArrayObject|null {
    return (string) $object;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getNormalizationSchema(mixed $object, array $context = []) : array {
    return $this->getJsonSchemaForMethod($object, '__toString', [
      'type' => 'string',
      'description' => 'May contain HTML markup.',
    ]);
  }
  
  /**
   * {@inheritdoc}
   */
  public function getSupportedTypes(?string $format) : array {
    return [
      MarkupInterface::class => TRUE,
    ];
  }

}

Members

Title 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.
MarkupNormalizer::doNormalize public function Normalizes an object into a set of arrays/scalars. Overrides SchematicNormalizerTrait::doNormalize
MarkupNormalizer::getNormalizationSchema public function Retrieve JSON Schema for the normalization. Overrides SchematicNormalizerTrait::getNormalizationSchema
MarkupNormalizer::getSupportedTypes public function Overrides NormalizerBase::getSupportedTypes
NormalizerBase::$format protected property List of formats which supports (de-)normalization. 1
NormalizerBase::addCacheableDependency protected function Adds cacheability if applicable.
NormalizerBase::supportsDenormalization public function Implements \Symfony\Component\Serializer\Normalizer\DenormalizerInterface::supportsDenormalization() 1
NormalizerBase::supportsNormalization public function 1
SchematicNormalizerFallbackTrait::generateNoSchemaAvailableMessage public static function
SchematicNormalizerHelperTrait::checkFormat protected function
SchematicNormalizerTrait::normalize public function 2

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