DurationIso8601.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/TypedData/Plugin/DataType/DurationIso8601.php
  2. 10 core/lib/Drupal/Core/TypedData/Plugin/DataType/DurationIso8601.php
  3. 11.x core/lib/Drupal/Core/TypedData/Plugin/DataType/DurationIso8601.php

Namespace

Drupal\Core\TypedData\Plugin\DataType

File

core/lib/Drupal/Core/TypedData/Plugin/DataType/DurationIso8601.php

View source
<?php

namespace Drupal\Core\TypedData\Plugin\DataType;

use Drupal\Core\TypedData\Type\DurationInterface;

/**
 * The duration ISO8601 data type.
 *
 * The plain value of this data type is a ISO8601 duration string.
 *
 * @DataType(
 *   id = "duration_iso8601",
 *   label = @Translation("Duration")
 * )
 */
class DurationIso8601 extends StringData implements DurationInterface {
    
    /**
     * {@inheritdoc}
     */
    public function getDuration() {
        if ($this->value) {
            // @todo: Add support for negative intervals on top of the DateInterval
            // constructor.
            return new \DateInterval($this->value);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function setDuration(\DateInterval $duration, $notify = TRUE) {
        // Generate an ISO 8601 formatted string as supported by
        // DateInterval::__construct() and setValue().
        $this->value = $duration->format('%rP%yY%mM%dDT%hH%mM%sS');
        // Notify the parent of any changes.
        if ($notify && isset($this->parent)) {
            $this->parent
                ->onChange($this->name);
        }
    }

}

Classes

Title Deprecated Summary
DurationIso8601 The duration ISO8601 data type.

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