class TimestampItemNormalizer

Same name in other branches
  1. 9 core/modules/serialization/src/Normalizer/TimestampItemNormalizer.php \Drupal\serialization\Normalizer\TimestampItemNormalizer
  2. 9 core/modules/hal/src/Normalizer/TimestampItemNormalizer.php \Drupal\hal\Normalizer\TimestampItemNormalizer
  3. 8.9.x core/modules/serialization/src/Normalizer/TimestampItemNormalizer.php \Drupal\serialization\Normalizer\TimestampItemNormalizer
  4. 8.9.x core/modules/hal/src/Normalizer/TimestampItemNormalizer.php \Drupal\hal\Normalizer\TimestampItemNormalizer
  5. 10 core/modules/serialization/src/Normalizer/TimestampItemNormalizer.php \Drupal\serialization\Normalizer\TimestampItemNormalizer

Converts values for TimestampItem to and from common formats.

Overrides FieldItemNormalizer to use \Drupal\serialization\Normalizer\TimestampNormalizer

Overrides FieldItemNormalizer to

Hierarchy

Expanded class hierarchy of TimestampItemNormalizer

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

File

core/modules/serialization/src/Normalizer/TimestampItemNormalizer.php, line 17

Namespace

Drupal\serialization\Normalizer
View source 
class TimestampItemNormalizer extends FieldItemNormalizer {
    
    /**
     * {@inheritdoc}
     */
    public function normalize($object, $format = NULL, array $context = []) : array|string|int|float|bool|\ArrayObject|null {
        return parent::normalize($object, $format, $context) + [
            // 'format' is not a property on Timestamp objects. This is present to
            // assist consumers of this data.
'format' => \DateTime::RFC3339,
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function constructValue($data, $context) {
        if (!empty($data['format'])) {
            $context['datetime_allowed_formats'] = [
                $data['format'],
            ];
        }
        return [
            'value' => $this->serializer
                ->denormalize($data['value'], Timestamp::class, NULL, $context),
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getSupportedTypes(?string $format) : array {
        return [
            TimestampItem::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.
FieldableEntityNormalizerTrait::$entityFieldManager protected property The entity field manager.
FieldableEntityNormalizerTrait::$entityTypeManager protected property The entity type manager.
FieldableEntityNormalizerTrait::$entityTypeRepository protected property The entity type repository.
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.
FieldItemNormalizer::denormalize public function
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
SerializedColumnNormalizerTrait::checkForSerializedStrings protected function Checks if there is a serialized string for a column.
SerializedColumnNormalizerTrait::dataHasStringForSerializeColumn protected function Checks if the data contains string value for serialize column.
SerializedColumnNormalizerTrait::getCustomSerializedPropertyNames protected function Gets the names of all properties the plugin treats as serialized data.
SerializedColumnNormalizerTrait::getSerializedPropertyNames protected function Gets the names of all serialized properties.
TimestampItemNormalizer::constructValue protected function Build the field item value using the incoming data. Overrides FieldableEntityNormalizerTrait::constructValue
TimestampItemNormalizer::getSupportedTypes public function Overrides FieldItemNormalizer::getSupportedTypes
TimestampItemNormalizer::normalize public function Overrides ComplexDataNormalizer::normalize

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