function TimeSpan::getDuration

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/TypedData/Plugin/DataType/TimeSpan.php \Drupal\Core\TypedData\Plugin\DataType\TimeSpan::getDuration()
  2. 8.9.x core/lib/Drupal/Core/TypedData/Plugin/DataType/TimeSpan.php \Drupal\Core\TypedData\Plugin\DataType\TimeSpan::getDuration()
  3. 10 core/lib/Drupal/Core/TypedData/Plugin/DataType/TimeSpan.php \Drupal\Core\TypedData\Plugin\DataType\TimeSpan::getDuration()

Returns the duration.

Return value

\DateInterval|null A DateInterval object or NULL if there is no duration.

Overrides DurationInterface::getDuration

File

core/lib/Drupal/Core/TypedData/Plugin/DataType/TimeSpan.php, line 30

Class

TimeSpan
The time span data type represents durations as number of seconds.

Namespace

Drupal\Core\TypedData\Plugin\DataType

Code

public function getDuration() {
  if ($this->value) {
    // Keep the duration in seconds as there is generally no valid way to
    // convert it to days, months or years.
    return new \DateInterval($this->getDurationAsIso8601Abnf());
  }
}

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