Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/Field/Plugin/Field/FieldType/ChangedItem.php \Drupal\Core\Field\Plugin\Field\FieldType\ChangedItem
  2. 9 core/lib/Drupal/Core/Field/Plugin/Field/FieldType/ChangedItem.php \Drupal\Core\Field\Plugin\Field\FieldType\ChangedItem

Defines the 'changed' entity field type.

Based on a field of this type, entity types can easily implement the EntityChangedInterface.

Plugin annotation


@FieldType(
  id = "changed",
  label = @Translation("Last changed"),
  description = @Translation("An entity field containing a UNIX timestamp of when the entity has been last updated."),
  no_ui = TRUE,
  default_widget = "datetime_timestamp",
  default_formatter = "timestamp",
  list_class = "\Drupal\Core\Field\ChangedFieldItemList"
)

Hierarchy

Expanded class hierarchy of ChangedItem

See also

\Drupal\Core\Entity\EntityChangedInterface

2 files declare their use of ChangedItem
ChangedTestItem.php in core/modules/system/tests/modules/entity_test/src/Plugin/Field/FieldType/ChangedTestItem.php
XmlEntityNormalizationQuirksTrait.php in core/modules/rest/tests/src/Functional/EntityResource/XmlEntityNormalizationQuirksTrait.php

File

core/lib/Drupal/Core/Field/Plugin/Field/FieldType/ChangedItem.php, line 23

Namespace

Drupal\Core\Field\Plugin\Field\FieldType
View source
class ChangedItem extends CreatedItem {

  /**
   * {@inheritdoc}
   */
  public function preSave() {
    parent::preSave();

    // Set the timestamp to request time if it is not set.
    if (!$this->value) {
      $this->value = \Drupal::time()
        ->getRequestTime();
    }
    else {

      // On an existing entity translation, the changed timestamp will only be
      // set to the request time automatically if at least one other field value
      // of the entity has changed. This detection does not run on new entities
      // and will be turned off if the changed timestamp is set manually before
      // save, for example during migrations or by using
      // \Drupal\content_translation\ContentTranslationMetadataWrapperInterface::setChangedTime().

      /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
      $entity = $this
        ->getEntity();

      /** @var \Drupal\Core\Entity\ContentEntityInterface $original */
      $original = $entity->original;
      $langcode = $entity
        ->language()
        ->getId();
      if (!$entity
        ->isNew() && $original && $original
        ->hasTranslation($langcode)) {
        $original_value = $original
          ->getTranslation($langcode)
          ->get($this
          ->getFieldDefinition()
          ->getName())->value;
        if ($this->value == $original_value && $entity
          ->hasTranslationChanges()) {
          $this->value = \Drupal::time()
            ->getRequestTime();
        }
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ChangedItem::preSave public function Defines custom presave behavior for field values. Overrides FieldItemBase::preSave 1
ComplexDataInterface::get public function Gets a property object.
ComplexDataInterface::getDataDefinition public function Gets the data definition. Overrides TypedDataInterface::getDataDefinition
ComplexDataInterface::getProperties public function Gets an array of property objects. 1
ComplexDataInterface::isEmpty public function Determines whether the data structure is empty. 15
ComplexDataInterface::set public function Sets a property value. 1
ComplexDataInterface::toArray public function Returns an array of all property values. 1
CreatedItem::applyDefaultValue public function Applies the default value. Overrides TypedDataInterface::applyDefaultValue
FieldItemBase::calculateDependencies public static function Calculates dependencies for field items. Overrides FieldItemInterface::calculateDependencies 2
FieldItemBase::calculateStorageDependencies public static function Calculates dependencies for field items on the storage level. Overrides FieldItemInterface::calculateStorageDependencies
FieldItemBase::defaultFieldSettings public static function Defines the field-level settings for this plugin. Overrides FieldItemInterface::defaultFieldSettings 6
FieldItemBase::defaultStorageSettings public static function Defines the storage-level settings for this plugin. Overrides FieldItemInterface::defaultStorageSettings 8
FieldItemBase::delete public function Defines custom delete behavior for field values. Overrides FieldItemInterface::delete 2
FieldItemBase::deleteRevision public function Defines custom revision delete behavior for field values. Overrides FieldItemInterface::deleteRevision
FieldItemBase::fieldSettingsForm public function Returns a form for the field-level settings. Overrides FieldItemInterface::fieldSettingsForm 6
FieldItemBase::fieldSettingsFromConfigData public static function Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::fieldSettingsFromConfigData 1
FieldItemBase::fieldSettingsSummary public static function Returns a short summary of the field's field-level settings. Overrides FieldItemInterface::fieldSettingsSummary
FieldItemBase::fieldSettingsToConfigData public static function Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::fieldSettingsToConfigData 1
FieldItemBase::getEntity public function Gets the entity that field belongs to. Overrides FieldItemInterface::getEntity
FieldItemBase::getFieldDefinition public function Gets the field definition. Overrides FieldItemInterface::getFieldDefinition
FieldItemBase::getLangcode public function Gets the langcode of the field values held in the object. Overrides FieldItemInterface::getLangcode
FieldItemBase::getSetting protected function Returns the value of a field setting.
FieldItemBase::getSettings protected function Returns the array of field settings.
FieldItemBase::mainPropertyName public static function Returns the name of the main property, if any. Overrides FieldItemInterface::mainPropertyName 8
FieldItemBase::onDependencyRemoval public static function Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemInterface::onDependencyRemoval
FieldItemBase::postSave public function Defines custom post-save behavior for field values. Overrides FieldItemInterface::postSave 2
FieldItemBase::setValue public function Sets the data value. Overrides TypedDataInterface::setValue 3
FieldItemBase::storageSettingsForm public function Returns a form for the storage-level settings. Overrides FieldItemInterface::storageSettingsForm 6
FieldItemBase::storageSettingsFromConfigData public static function Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::storageSettingsFromConfigData 1
FieldItemBase::storageSettingsSummary public static function Returns a short summary of the field's storage-level settings. Overrides FieldItemInterface::storageSettingsSummary
FieldItemBase::storageSettingsToConfigData public static function Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::storageSettingsToConfigData 1
FieldItemBase::view public function Returns a renderable array for a single field item. Overrides FieldItemInterface::view
FieldItemBase::writePropertyValue protected function Different to the parent Map class, we avoid creating property objects as far as possible in order to optimize performance. Thus we just update $this->values if no property object has been created yet.
FieldItemBase::__construct public function 2
FieldItemBase::__get public function Magic method: Gets a property value. Overrides FieldItemInterface::__get 2
FieldItemBase::__isset public function Magic method: Determines whether a property is set. Overrides FieldItemInterface::__isset
FieldItemBase::__set public function Magic method: Sets a property value. Overrides FieldItemInterface::__set 1
FieldItemBase::__unset public function Magic method: Unsets a property. Overrides FieldItemInterface::__unset
TimestampItem::generateSampleValue public static function Generates placeholder field values. Overrides FieldItemBase::generateSampleValue
TimestampItem::propertyDefinitions public static function Defines field item properties. Overrides FieldItemInterface::propertyDefinitions
TimestampItem::schema public static function Returns the schema for the field. Overrides FieldItemInterface::schema
TraversableTypedDataInterface::onChange public function React to changes to a child property or item. 5
TypedDataInterface::createInstance public static function Constructs a TypedData object given its definition and context. 1
TypedDataInterface::getConstraints public function Gets a list of validation constraints. 9
TypedDataInterface::getName public function Returns the name of a property or item. 1
TypedDataInterface::getParent public function Returns the parent data structure; i.e. either complex data or a list. 1
TypedDataInterface::getPropertyPath public function Returns the property path of the data. 1
TypedDataInterface::getRoot public function Returns the root of the typed data tree. 1
TypedDataInterface::getString public function Returns a string representation of the data. 1
TypedDataInterface::getValue public function Gets the data value. 1
TypedDataInterface::setContext public function Sets the context of a property or item via a context aware parent. 1
TypedDataInterface::validate public function Validates the currently set data value. 1