class TimestampItem

Defines the 'timestamp' entity field type.

Plugin annotation

@FieldType(
  id = "timestamp",
  label = @Translation("Timestamp"),
  description = @Translation("An entity field containing a UNIX timestamp value."),
  default_widget = "datetime_timestamp",
  default_formatter = "timestamp",
  constraints = {
    "ComplexData" = {
      "value" = {
        "Range" = {
          "min" = "-2147483648",
          "max" = "2147483648",
        }
      }
    }
  }
)

Hierarchy

• class \Drupal\Core\TypedData\TypedData implements \Drupal\Core\TypedData\TypedDataInterface, \Drupal\Component\Plugin\PluginInspectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\TypedData\TypedDataTrait
  • class \Drupal\Core\TypedData\Plugin\DataType\Map implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, \Drupal\Core\TypedData\ComplexDataInterface extends \Drupal\Core\TypedData\TypedData
    • class \Drupal\Core\Field\FieldItemBase implements \Drupal\Core\Field\FieldItemInterface extends \Drupal\Core\TypedData\Plugin\DataType\Map
      • class \Drupal\Core\Field\Plugin\Field\FieldType\TimestampItem extends \Drupal\Core\Field\FieldItemBase

Expanded class hierarchy of TimestampItem

File

core/lib/Drupal/Core/Field/Plugin/Field/FieldType/TimestampItem.php, line 31

Namespace

class TimestampItem extends FieldItemBase {
  
  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    $properties['value'] = DataDefinition::create('timestamp')->setLabel(t('Timestamp value'))
      ->setRequired(TRUE);
    return $properties;
  }
  
  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field_definition) {
    return [
      'columns' => [
        'value' => [
          'type' => 'int',
        ],
      ],
    ];
  }
  
  /**
   * {@inheritdoc}
   */
  public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
    // Pick a random timestamp in the past year.
    $timestamp = \Drupal::time()->getRequestTime() - mt_rand(0, 86400 * 365);
    $values['value'] = $timestamp;
    return $values;
  }

}

Members