class TimestampItemNormalizer

Converts values for TimestampItem to and from common formats for hal.

Overrides FieldItemNormalizer to

Hierarchy

Expanded class hierarchy of TimestampItemNormalizer

1 string reference to 'TimestampItemNormalizer'
hal.services.yml in core/modules/hal/hal.services.yml
core/modules/hal/hal.services.yml
1 service uses TimestampItemNormalizer
serializer.normalizer.timestamp_item.hal in core/modules/hal/hal.services.yml
Drupal\hal\Normalizer\TimestampItemNormalizer

File

View on git.drupalcode.org

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

Namespace

Drupal\hal\Normalizer
View source 
class TimestampItemNormalizer extends FieldItemNormalizer {
  
  /**
   * {@inheritdoc}
   */
  protected $supportedInterfaceOrClass = TimestampItem::class;
  
  /**
   * {@inheritdoc}
   */
  protected function normalizedFieldValues(FieldItemInterface $field_item, $format, array $context) {
    return parent::normalizedFieldValues($field_item, $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 hasCacheableSupportsMethod() : bool {
    return 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. 1
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::createTranslatedInstance protected function Get a translated version of the field item instance.
FieldItemNormalizer::denormalize public function
FieldItemNormalizer::normalize public function 1
NormalizerBase::$format protected property List of formats which supports (de-)normalization. Overrides NormalizerBase::$format
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::$supportedInterfaceOrClass protected property The interface or class that this Normalizer supports. Overrides FieldItemNormalizer::$supportedInterfaceOrClass
TimestampItemNormalizer::constructValue protected function Build the field item value using the incoming data. Overrides FieldableEntityNormalizerTrait::constructValue
TimestampItemNormalizer::hasCacheableSupportsMethod public function Overrides FieldItemNormalizer::hasCacheableSupportsMethod
TimestampItemNormalizer::normalizedFieldValues protected function Normalizes field values for an item. Overrides FieldItemNormalizer::normalizedFieldValues

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