Issue #2002102 by Berdir, fago, dixon_: Move TypedData primitive types to interfaces.

core/lib/Drupal/Core/Plugin/Context/Context.php

@@ -85,17 +85,10 @@ public function getConstraints() {
    * Overrides \Drupal\Component\Plugin\Context\Context::getConstraints().
    */
   public function validate() {
-    $validator = Validation::createValidatorBuilder()
-      ->setTranslator(new DrupalTranslator())
-      ->getValidator();
-
-    // @todo We won't need to special case "entity" here once #1868004 lands.
-    if (!empty($this->contextDefinition['type']) && $this->contextDefinition['type'] == 'entity') {
-      $value = $this->getTypedContext();
-    }
-    else {
-      $value = $this->getContextValue();
+    // If the context is typed data, defer to its validation.
+    if (!empty($this->contextDefinition['type'])) {
+      return $this->getTypedContext()->validate();
     }
-    return $validator->validateValue($value, $this->getConstraints());
+    return parent::validate();
   }
 }

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

@@ -7,6 +7,8 @@
 
 namespace Drupal\Core\TypedData\Plugin\DataType;
 
+use Drupal\Core\TypedData\PrimitiveBase;
+use Drupal\Core\TypedData\Type\BinaryInterface;
 use Drupal\Core\TypedData\Annotation\DataType;
 use Drupal\Core\Annotation\Translation;
 use Drupal\Core\TypedData\TypedData;
@@ -20,11 +22,10 @@
  *
  * @DataType(
  *   id = "binary",
- *   label = @Translation("Binary"),
- *   primitive_type = 8
+ *   label = @Translation("Binary")
  * )
  */
-class Binary extends TypedData {
+class Binary extends PrimitiveBase implements BinaryInterface {
 
   /**
    * The file resource URI.

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

@@ -9,7 +9,8 @@
 
 use Drupal\Core\TypedData\Annotation\DataType;
 use Drupal\Core\Annotation\Translation;
-use Drupal\Core\TypedData\TypedData;
+use Drupal\Core\TypedData\PrimitiveBase;
+use Drupal\Core\TypedData\Type\BooleanInterface;
 
 /**
  * The boolean data type.
@@ -19,16 +20,9 @@
  *
  * @DataType(
  *   id = "boolean",
- *   label = @Translation("Boolean"),
- *   primitive_type = 1
+ *   label = @Translation("Boolean")
  * )
  */
-class Boolean extends TypedData {
+class Boolean extends PrimitiveBase implements BooleanInterface {
 
-  /**
-   * The data value.
-   *
-   * @var boolean
-   */
-  protected $value;
 }

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

-<?php
-
-/**
- * @file
- * Contains \Drupal\Core\TypedData\Plugin\DataType\Date.
- */
-
-namespace Drupal\Core\TypedData\Plugin\DataType;
-
-use Drupal\Core\TypedData\Annotation\DataType;
-use Drupal\Core\Annotation\Translation;
-use Drupal\Core\Datetime\DrupalDateTime;
-use Drupal\Core\TypedData\TypedData;
-
-/**
- * The date data type.
- *
- * The plain value of a date is an instance of the DrupalDateTime class. For
- * setting the value any value supported by the __construct() of the
- * DrupalDateTime class will work, including a DateTime object, a timestamp, a
- * string date, or an array of date parts.
- *
- * @DataType(
- *   id = "date",
- *   label = @Translation("Date"),
- *   primitive_type = 5
- * )
- */
-class Date extends TypedData {
-
-  /**
-   * The data value.
-   *
-   * @var DateTime
-   */
-  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);
-    }
-    // Don't try to create a date from an empty value.
-    // It would default to the current time.
-    if (!isset($value)) {
-      $this->value = $value;
-    }
-    else {
-      $this->value = $value instanceOf DrupalDateTime ? $value : new DrupalDateTime($value);
-    }
-  }
-}

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

+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Core\TypedData\Plugin\DataType\DateTimeIso8601.
+ */
+
+namespace Drupal\Core\TypedData\Plugin\DataType;
+
+use Drupal\Core\TypedData\Annotation\DataType;
+use Drupal\Core\Annotation\Translation;
+use Drupal\Core\Datetime\DrupalDateTime;
+use Drupal\Core\TypedData\Type\DateTimeInterface;
+
+/**
+ * A data type for ISO 8601 date strings.
+ *
+ * The plain value of this data type is a date string in ISO 8601 format.
+ *
+ * @DataType(
+ *   id = "datetime_iso8601",
+ *   label = @Translation("Date")
+ * )
+ */
+class DateTimeIso8601 extends String implements DateTimeInterface {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getDateTime() {
+    if ($this->value) {
+      return new DrupalDateTime($this->value);
+    }
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setDateTime(DrupalDateTime $dateTime) {
+    $this->value = $dateTime->format('c');
+  }
+}
+

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

-<?php
-
-/**
- * @file
- * Contains \Drupal\Core\TypedData\Plugin\DataType\Duration.
- */
-
-namespace Drupal\Core\TypedData\Plugin\DataType;
-
-use Drupal\Core\TypedData\Annotation\DataType;
-use Drupal\Core\Annotation\Translation;
-use Drupal\Core\TypedData\TypedData;
-use DateInterval;
-
-/**
- * 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.
- *
- * @DataType(
- *   id = "duration",
- *   label = @Translation("Duration"),
- *   primitive_type = 6
- * )
- */
-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;
-      }
-      // Treat integer values as time spans in seconds, even if supplied as PHP
-      // string.
-      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');
-  }
-}

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

+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Core\TypedData\Plugin\DataType\DurationIso8601.
+ */
+
+namespace Drupal\Core\TypedData\Plugin\DataType;
+
+use Drupal\Core\TypedData\Annotation\DataType;
+use Drupal\Core\Annotation\Translation;
+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 String 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) {
+    // Generate an ISO 8601 formatted string as supported by
+    // DateInterval::__construct() and setValue().
+    $this->value = $duration->format('%rP%yY%mM%dDT%hH%mM%sS');
+  }
+
+}

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

@@ -9,6 +9,7 @@
 
 use Drupal\Core\TypedData\Annotation\DataType;
 use Drupal\Core\Annotation\Translation;
+use Drupal\Core\TypedData\Type\StringInterface;
 
 /**
  * The Email data type.
@@ -18,10 +19,9 @@
  * @DataType(
  *   id = "email",
  *   label = @Translation("Email"),
- *   primitive_type = 2,
  *   constraints = {"Email" = TRUE}
  * )
  */
-class Email extends String {
+class Email extends String implements StringInterface {
 
 }

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

@@ -9,7 +9,8 @@
 
 use Drupal\Core\TypedData\Annotation\DataType;
 use Drupal\Core\Annotation\Translation;
-use Drupal\Core\TypedData\TypedData;
+use Drupal\Core\TypedData\PrimitiveBase;
+use Drupal\Core\TypedData\Type\FloatInterface;
 
 /**
  * The float data type.
@@ -19,16 +20,9 @@
  *
  * @DataType(
  *   id = "float",
- *   label = @Translation("Float"),
- *   primitive_type = 4
+ *   label = @Translation("Float")
  * )
  */
-class Float extends TypedData {
+class Float extends PrimitiveBase implements FloatInterface {
 
-  /**
-   * The data value.
-   *
-   * @var float
-   */
-  protected $value;
 }

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

@@ -9,7 +9,8 @@
 
 use Drupal\Core\TypedData\Annotation\DataType;
 use Drupal\Core\Annotation\Translation;
-use Drupal\Core\TypedData\TypedData;
+use Drupal\Core\TypedData\PrimitiveBase;
+use Drupal\Core\TypedData\Type\IntegerInterface;
 
 /**
  * The integer data type.
@@ -19,16 +20,9 @@
  *
  * @DataType(
  *   id = "integer",
- *   label = @Translation("Integer"),
- *   primitive_type = 3
+ *   label = @Translation("Integer")
  * )
  */
-class Integer extends TypedData {
+class Integer extends PrimitiveBase implements IntegerInterface {
 
-  /**
-   * The data value.
-   *
-   * @var integer
-   */
-  protected $value;
 }

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

@@ -9,7 +9,8 @@
 
 use Drupal\Core\TypedData\Annotation\DataType;
 use Drupal\Core\Annotation\Translation;
-use Drupal\Core\TypedData\TypedData;
+use Drupal\Core\TypedData\PrimitiveBase;
+use Drupal\Core\TypedData\Type\StringInterface;
 
 /**
  * The string data type.
@@ -19,16 +20,9 @@
  *
  * @DataType(
  *   id = "string",
- *   label = @Translation("String"),
- *   primitive_type = 2
+ *   label = @Translation("String")
  * )
  */
-class String extends TypedData {
+class String extends PrimitiveBase implements StringInterface {
 
-  /**
-   * The data value.
-   *
-   * @var string
-   */
-  protected $value;
 }

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

+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Core\TypedData\Type\TimeSpan.
+ */
+
+namespace Drupal\Core\TypedData\Plugin\DataType;
+
+use Drupal\Core\TypedData\Annotation\DataType;
+use Drupal\Core\Annotation\Translation;
+use Drupal\Core\TypedData\Type\DurationInterface;
+
+/**
+ * The time span data type represents durations as number of seconds.
+ *
+ * The plain value is the (integer) number of seconds. Note that time spans only
+ * map correctly to durations as long as the number of seconds does not exceed
+ * a day (there is already a difference in applying a duration of a day or 24
+ * hours due to daylight savings). If that's an issue, consider using
+ * \Drupal\Core\TypedData\Type\DurationIso8601 instead.
+ *
+ * @DataType(
+ *   id = "timespan",
+ *   label = @Translation("Time span in seconds")
+ * )
+ *
+ * @see \Drupal\Core\TypedData\Type\DurationIso8601
+ */
+class TimeSpan extends Integer implements DurationInterface {
+
+  /**
+   * {@inheritdoc}
+   */
+  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('PT' . $this->value . 'S');
+    }
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setDuration(\DateInterval $duration) {
+    // Note that this applies the assumption of 12 month's a 30 days and
+    // each year having 365 days. There is no accurate conversion for time spans
+    // exceeding a day.
+    $this->value = ($duration->y * 365 * 24 * 60 * 60) +
+      ($duration->m * 30 * 24 * 60 * 60) +
+      ($duration->d * 24 * 60 * 60) +
+      ($duration->h * 60 * 60) +
+      ($duration->i * 60) +
+       $duration->s;
+  }
+
+}

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

+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Core\TypedData\Type\Timestamp.
+ */
+
+namespace Drupal\Core\TypedData\Plugin\DataType;
+
+use Drupal\Core\TypedData\Annotation\DataType;
+use Drupal\Core\Annotation\Translation;
+use Drupal\Core\Datetime\DrupalDateTime;
+use Drupal\Core\TypedData\Type\DateTimeInterface;
+
+/**
+ * The timestamp data type.
+ *
+ * @DataType(
+ *   id = "timestamp",
+ *   label = @Translation("String")
+ * )
+ */
+class Timestamp extends Integer implements DateTimeInterface {
+
+  /**
+   * The data value as a UNIX timestamp.
+   *
+   * @var integer
+   */
+  protected $value;
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getDateTime() {
+    if ($this->value) {
+      return new DrupalDateTime($this->value);
+    }
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setDateTime(DrupalDateTime $dateTime) {
+    $this->value = $dateTime->getTimestamp();
+  }
+}

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

@@ -9,6 +9,8 @@
 
 use Drupal\Core\TypedData\Annotation\DataType;
 use Drupal\Core\Annotation\Translation;
+use Drupal\Core\TypedData\PrimitiveBase;
+use Drupal\Core\TypedData\Type\UriInterface;
 use Drupal\Core\TypedData\TypedData;
 
 /**
@@ -18,16 +20,9 @@
  *
  * @DataType(
  *   id = "uri",
- *   label = @Translation("URI"),
- *   primitive_type = 7
+ *   label = @Translation("URI")
  * )
  */
-class Uri extends TypedData {
+class Uri extends PrimitiveBase implements UriInterface {
 
-  /**
-   * The data value.
-   *
-   * @var string
-   */
-  protected $value;
 }

core/lib/Drupal/Core/TypedData/Primitive.php

-<?php
-
-/**
- * @file
- * Contains \Drupal\Core\TypedData\Primitive.
- */
-
-namespace Drupal\Core\TypedData;
-
-/**
- * Class that holds constants for all primitive data types.
- */
-final class Primitive {
-
-  /**
-   * The BOOLEAN primitive data type.
-   *
-   * @see \Drupal\Core\TypedData\Plugin\DataType\Boolean
-   */
-  const BOOLEAN = 1;
-
-  /**
-   * The STRING primitive data type.
-   *
-   * @see \Drupal\Core\TypedData\Plugin\DataType\String
-   */
-  const STRING = 2;
-
-  /**
-   * The INTEGER primitive data type.
-   *
-   * @see \Drupal\Core\TypedData\Plugin\DataType\Integer
-   */
-  const INTEGER = 3;
-
-  /**
-   * The FLOAT primitive data type.
-   *
-   * @see \Drupal\Core\TypedData\Plugin\DataType\Float
-   */
-  const FLOAT = 4;
-
-  /**
-   * The DATE primitive data type.
-   *
-   * @see \Drupal\Core\TypedData\Plugin\DataType\Date
-   */
-  const DATE = 5;
-
-  /**
-   * The DURATION primitive data type.
-   *
-   * @see \Drupal\Core\TypedData\Plugin\DataType\Duration
-   */
-  const DURATION = 6;
-
-  /**
-   * The URI primitive data type.
-   *
-   * @see \Drupal\Core\TypedData\Plugin\DataType\Uri
-   */
-  const URI = 7;
-
-  /**
-   * The BINARY primitive data type.
-   *
-   * @see \Drupal\Core\TypedData\Plugin\DataType\Binary
-   */
-  const BINARY = 8;
-}

core/lib/Drupal/Core/TypedData/PrimitiveBase.php

+<?php
+
+/**
+ * @file
+ * Contains \Drupal\Core\TypedData\PrimitiveBase.
+ */
+
+namespace Drupal\Core\TypedData;
+
+/**
+ * Base class for primitive data types.
+ */
+abstract class PrimitiveBase extends TypedData implements PrimitiveInterface {