class DateTimeIso8601
Same name in other branches
- 8.9.x core/lib/Drupal/Core/TypedData/Plugin/DataType/DateTimeIso8601.php \Drupal\Core\TypedData\Plugin\DataType\DateTimeIso8601
- 10 core/lib/Drupal/Core/TypedData/Plugin/DataType/DateTimeIso8601.php \Drupal\Core\TypedData\Plugin\DataType\DateTimeIso8601
- 11.x core/lib/Drupal/Core/TypedData/Plugin/DataType/DateTimeIso8601.php \Drupal\Core\TypedData\Plugin\DataType\DateTimeIso8601
A data type for ISO 8601 date strings.
The plain value of this data type is a date string in ISO 8601 format.
Plugin annotation
@DataType(
id = "datetime_iso8601",
label = @Translation("Date")
)
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\PrimitiveBase extends \Drupal\Core\TypedData\TypedData implements \Drupal\Core\TypedData\PrimitiveInterface
- class \Drupal\Core\TypedData\Plugin\DataType\StringData extends \Drupal\Core\TypedData\PrimitiveBase implements \Drupal\Core\TypedData\Type\StringInterface
- class \Drupal\Core\TypedData\Plugin\DataType\DateTimeIso8601 extends \Drupal\Core\TypedData\Plugin\DataType\StringData implements \Drupal\Core\TypedData\Type\DateTimeInterface
- class \Drupal\Core\TypedData\Plugin\DataType\StringData extends \Drupal\Core\TypedData\PrimitiveBase implements \Drupal\Core\TypedData\Type\StringInterface
- class \Drupal\Core\TypedData\PrimitiveBase extends \Drupal\Core\TypedData\TypedData implements \Drupal\Core\TypedData\PrimitiveInterface
Expanded class hierarchy of DateTimeIso8601
3 files declare their use of DateTimeIso8601
- DateTimeIso8601Normalizer.php in core/
modules/ serialization/ src/ Normalizer/ DateTimeIso8601Normalizer.php - DateTimeIso8601NormalizerTest.php in core/
modules/ serialization/ tests/ src/ Unit/ Normalizer/ DateTimeIso8601NormalizerTest.php - DateTimeNormalizerTest.php in core/
modules/ serialization/ tests/ src/ Unit/ Normalizer/ DateTimeNormalizerTest.php
File
-
core/
lib/ Drupal/ Core/ TypedData/ Plugin/ DataType/ DateTimeIso8601.php, line 18
Namespace
Drupal\Core\TypedData\Plugin\DataTypeView source
class DateTimeIso8601 extends StringData implements DateTimeInterface {
/**
* {@inheritdoc}
*/
public function getDateTime() {
if ($this->value) {
if (is_array($this->value)) {
// Data of this type must always be stored in UTC.
$datetime = DrupalDateTime::createFromArray($this->value, 'UTC');
}
else {
// Data of this type must always be stored in UTC.
$datetime = new DrupalDateTime($this->value, 'UTC');
}
return $datetime;
}
}
/**
* {@inheritdoc}
*/
public function setDateTime(DrupalDateTime $dateTime, $notify = TRUE) {
$this->value = $dateTime->format('c');
// Notify the parent of any changes.
if ($notify && isset($this->parent)) {
$this->parent
->onChange($this->name);
}
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DateTimeIso8601::getDateTime | public | function | Returns the date time object. | Overrides DateTimeInterface::getDateTime | |
DateTimeIso8601::setDateTime | public | function | Sets the date time object. | Overrides DateTimeInterface::setDateTime | |
DependencySerializationTrait::$_entityStorages | protected | property | |||
DependencySerializationTrait::$_serviceIds | protected | property | |||
DependencySerializationTrait::__sleep | public | function | 1 | ||
DependencySerializationTrait::__wakeup | public | function | 2 | ||
PrimitiveBase::$value | protected | property | The data value. | 1 | |
PrimitiveBase::getValue | public | function | Gets the data value. | Overrides TypedData::getValue | 1 |
PrimitiveBase::setValue | public | function | Sets the data value. | Overrides TypedData::setValue | 1 |
StringData::getCastedValue | public | function | Gets the primitive data value casted to the correct PHP type. | Overrides PrimitiveInterface::getCastedValue | |
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | ||
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | ||
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | ||
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | |
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | ||
TypedData::$definition | protected | property | The data definition. | 1 | |
TypedData::$name | protected | property | The property name. | ||
TypedData::$parent | protected | property | The parent typed data object. | ||
TypedData::applyDefaultValue | public | function | Applies the default value. | Overrides TypedDataInterface::applyDefaultValue | 3 |
TypedData::createInstance | public static | function | Constructs a TypedData object given its definition and context. | Overrides TypedDataInterface::createInstance | |
TypedData::getConstraints | public | function | Gets a list of validation constraints. | Overrides TypedDataInterface::getConstraints | 9 |
TypedData::getDataDefinition | public | function | Gets the data definition. | Overrides TypedDataInterface::getDataDefinition | |
TypedData::getName | public | function | Returns the name of a property or item. | Overrides TypedDataInterface::getName | |
TypedData::getParent | public | function | Returns the parent data structure; i.e. either complex data or a list. | Overrides TypedDataInterface::getParent | |
TypedData::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | Overrides PluginInspectionInterface::getPluginDefinition | |
TypedData::getPluginId | public | function | Gets the plugin_id of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | |
TypedData::getPropertyPath | public | function | Returns the property path of the data. | Overrides TypedDataInterface::getPropertyPath | |
TypedData::getRoot | public | function | Returns the root of the typed data tree. | Overrides TypedDataInterface::getRoot | |
TypedData::getString | public | function | Returns a string representation of the data. | Overrides TypedDataInterface::getString | 6 |
TypedData::setContext | public | function | Sets the context of a property or item via a context aware parent. | Overrides TypedDataInterface::setContext | |
TypedData::validate | public | function | Validates the currently set data value. | Overrides TypedDataInterface::validate | |
TypedData::__construct | public | function | Constructs a TypedData object given its definition and context. | 3 | |
TypedDataTrait::$typedDataManager | protected | property | The typed data manager used for creating the data types. | ||
TypedDataTrait::getTypedDataManager | public | function | Gets the typed data manager. | 2 | |
TypedDataTrait::setTypedDataManager | public | function | Sets the typed data manager. | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.