class TraversableObjectNormalizer

Same name and namespace in other branches
  1. 10 core/modules/jsonapi/tests/modules/jsonapi_test_data_type/src/Normalizer/TraversableObjectNormalizer.php \Drupal\jsonapi_test_data_type\Normalizer\TraversableObjectNormalizer
  2. 11.x core/modules/jsonapi/tests/modules/jsonapi_test_data_type/src/Normalizer/TraversableObjectNormalizer.php \Drupal\jsonapi_test_data_type\Normalizer\TraversableObjectNormalizer
  3. 9 core/modules/jsonapi/tests/modules/jsonapi_test_data_type/src/Normalizer/TraversableObjectNormalizer.php \Drupal\jsonapi_test_data_type\Normalizer\TraversableObjectNormalizer
  4. 8.9.x core/modules/jsonapi/tests/modules/jsonapi_test_data_type/src/Normalizer/TraversableObjectNormalizer.php \Drupal\jsonapi_test_data_type\Normalizer\TraversableObjectNormalizer

Normalizes TraversableObject.

Hierarchy

Expanded class hierarchy of TraversableObjectNormalizer

1 string reference to 'TraversableObjectNormalizer'
jsonapi_test_data_type.services.yml in core/modules/jsonapi/tests/modules/jsonapi_test_data_type/jsonapi_test_data_type.services.yml
core/modules/jsonapi/tests/modules/jsonapi_test_data_type/jsonapi_test_data_type.services.yml
1 service uses TraversableObjectNormalizer
serializer.normalizer.traversable_object.jsonapi_test_data_type in core/modules/jsonapi/tests/modules/jsonapi_test_data_type/jsonapi_test_data_type.services.yml
Drupal\jsonapi_test_data_type\Normalizer\TraversableObjectNormalizer

File

core/modules/jsonapi/tests/modules/jsonapi_test_data_type/src/Normalizer/TraversableObjectNormalizer.php, line 13

Namespace

Drupal\jsonapi_test_data_type\Normalizer
View source
class TraversableObjectNormalizer extends NormalizerBase {
  
  /**
   * Normalizes data into a set of arrays/scalars.
   *
   * @param object $object
   *   Data to normalize.
   * @param string|null $format
   *   Format the normalization result will be encoded as.
   * @param array<string, mixed> $context
   *   Context options for the normalizer.
   *
   * @return array|string|int|float|bool|\ArrayObject<mixed, mixed>|null
   *   \ArrayObject is used to make sure an empty object is encoded as an
   *   object not an array.
   */
  public function normalize($object, $format = NULL, array $context = []) : array|string|int|float|bool|\ArrayObject|null {
    return $object->property;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getSupportedTypes(?string $format) : array {
    return [
      TraversableObject::class => TRUE,
    ];
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY constant Name of key for bubbling cacheability metadata via serialization context.
NormalizerBase::$format protected property List of formats which supports (de-)normalization. 1
NormalizerBase::addCacheableDependency protected function Adds cacheability if applicable.
NormalizerBase::checkFormat protected function Checks if the provided format is supported by this normalizer. 1
NormalizerBase::supportsDenormalization public function Implements \Symfony\Component\Serializer\Normalizer\DenormalizerInterface::supportsDenormalization() 1
NormalizerBase::supportsNormalization public function 1
TraversableObjectNormalizer::getSupportedTypes public function Overrides NormalizerBase::getSupportedTypes
TraversableObjectNormalizer::normalize public function Normalizes data into a set of arrays/scalars.

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