Documentation & API reference
class Duration
The duration data type.
The plain value of a duration is an instance of the DateInterval class. For setting the value an instance of the DateInterval class, a ISO8601 string as supported by DateInterval::__construct, or an integer in seconds may be passed.
Hierarchy
- class \Drupal\Core\TypedData\TypedData implements TypedDataInterface
- class \Drupal\Core\TypedData\Type\Duration
Expanded class hierarchy of Duration
1 string reference to 'Duration'
- system_data_type_info in drupal/
core/ modules/ system/ system.module - Implements hook_data_type_info().
File
- drupal/
core/ lib/ Drupal/ Core/ TypedData/ Type/ Duration.php, line 22 - Contains \Drupal\Core\TypedData\Type\Duration.
Namespace
Drupal\Core\TypedData\TypeView source
class Duration extends TypedData {
/**
* The data value.
*
* @var \DateInterval
*/
protected $value;
/**
* Overrides TypedData::setValue().
*/
public function setValue($value, $notify = TRUE) {
// Notify the parent of any changes to be made.
if ($notify && isset($this->parent)) {
$this->parent
->onChange($this->name);
}
// Catch any exceptions thrown due to invalid values being passed.
try {
if ($value instanceof DateInterval || !isset($value)) {
$this->value = $value;
}
elseif ((string) (int) $value === (string) $value) {
$this->value = new DateInterval('PT' . $value . 'S');
}
elseif (is_string($value)) {
// @todo: Add support for negative intervals on top of the DateInterval
// constructor.
$this->value = new DateInterval($value);
}
else {
// Unknown value given.
$this->value = $value;
}
} catch (\Exception $e) {
// An invalid value has been given. Setting any invalid value will let
// validation fail.
$this->value = $e;
}
}
/**
* Overrides TypedData::getString().
*/
public function getString() {
// Generate an ISO 8601 formatted string as supported by
// DateInterval::__construct() and setValue().
return (string) $this
->getValue()
->format('%rP%yY%mM%dDT%hH%mM%sS');
}
}