You are here

class DateIntervalData in Duration Field 3.0.x

Same name and namespace in other branches
  1. 8.2 src/Plugin/DataType/DateIntervalData.php \Drupal\duration_field\Plugin\DataType\DateIntervalData

Provides the Date Interval data type.

This data type is the wrapper for PHP DateInterval objects.

Plugin annotation


@DataType(
  id = "php_date_interval",
  label = @Translation("Date Interval"),
)

Hierarchy

Expanded class hierarchy of DateIntervalData

See also

http://php.net/dateinterval

File

src/Plugin/DataType/DateIntervalData.php, line 20

Namespace

Drupal\duration_field\Plugin\DataType
View source
class DateIntervalData extends PrimitiveBase implements DateIntervalInterface {

  /**
   * {@inheritdoc}
   */
  public function setValue($value, $notify = TRUE) {
    $duration_service = \Drupal::service('duration_field.service');
    if (is_a($value, 'DateInterval')) {

      // The value should always be an ISO 8601 Duration String.
      $value = $duration_service
        ->getDurationStringFromDateInterval($value);
    }
    $duration_service
      ->checkDurationInvalid($value);
    parent::setValue($value, $notify);
  }

  /**
   * {@inheritdoc}
   */
  public function getCastedValue() {

    // The casted value will be a PHP DateInterval object. The value of the
    // object is an ISO 8601 Duration string, used to create the
    // DateInterval object.
    return new DateInterval($this
      ->getString());
  }

  /**
   * {@inheritdoc}
   */
  public function getConstraints() {
    $constraint_manager = \Drupal::typedDataManager()
      ->getValidationConstraintManager();
    $constraints = parent::getConstraints();

    // Add a constraint to ensure that submitted data is valid for a PHP
    // DateInterval object.
    $constraints[] = $constraint_manager
      ->create('php_date_interval', []);
    return $constraints;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DateIntervalData::getCastedValue public function Gets the primitive data value casted to the correct PHP type. Overrides PrimitiveInterface::getCastedValue
DateIntervalData::getConstraints public function Gets a list of validation constraints. Overrides TypedData::getConstraints
DateIntervalData::setValue public function Sets the data value. Overrides PrimitiveBase::setValue
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
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
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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::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