Merge pull request #212 from scy/datetimeinterface

Use DateTimeInterface instead of DateTime

Author: lesstif

composer.json

@@ -6,6 +6,7 @@
     "require": {
         "php": ">=5.5.9",
         "ext-curl": "*",
+        "ext-json": "*",
         "netresearch/jsonmapper": "~0.11|^1.0",
         "monolog/monolog": "~1.12",
         "vlucas/phpdotenv": "~1.0|~2.0"

src/Issue/Attachment.php

@@ -16,7 +16,7 @@ class Attachment implements \JsonSerializable
     /* @var \JiraRestApi\Issue\Reporter */
     public $author;
 
-    /* @var \DateTime */
+    /* @var \DateTimeInterface */
     public $created;
 
     /* @var int */

src/Issue/Comment.php

@@ -21,10 +21,10 @@ class Comment implements \JsonSerializable
     /** @var \JiraRestApi\Issue\Reporter */
     public $updateAuthor;
 
-    /** @var \DateTime */
+    /** @var \DateTimeInterface */
     public $created;
 
-    /** @var \DateTime */
+    /** @var \DateTimeInterface */
     public $updated;
 
     /** @var \JiraRestApi\Issue\Visibility */

src/Issue/IssueField.php

@@ -23,10 +23,10 @@ class IssueField implements \JsonSerializable
     /** @var Reporter|null */
     public $reporter;
 
-    /** @var \DateTime */
+    /** @var \DateTimeInterface */
     public $created;
 
-    /** @var \DateTime */
+    /** @var \DateTimeInterface */
     public $updated;
 
     /** @var string|null */
@@ -92,7 +92,7 @@ class IssueField implements \JsonSerializable
     /** @var string|null */
     public $resolutiondate;
 
-    /** @var \DateTime|null */
+    /** @var \DateTimeInterface|null */
     public $duedate;
 
     /** @var array */
@@ -412,16 +412,16 @@ public function setSecurityId($id)
     /**
      * set issue's due date.
      *
-     * @param \DateTime|null $duedate due date string or DateTime object
-     * @param string         $format  datetime string format.
+     * @param string|\DateTimeInterface|null $duedate due date string or DateTimeInterface object
+     * @param string                         $format  datetime string format.
      *
      * @return $this
      */
     public function setDueDate($duedate, $format = 'Y-m-d')
     {
         if (is_string($duedate)) {
             $this->duedate = $duedate;
-        } elseif ($duedate instanceof \DateTime) {
+        } elseif ($duedate instanceof \DateTimeInterface) {
             $this->duedate = $duedate->format($format);
         } else {
             $this->duedate = null;

src/Issue/Version.php

@@ -22,7 +22,7 @@ class Version implements \JsonSerializable
     /** @var bool */
     public $released;
 
-    /** @var \DateTime|null */
+    /** @var \DateTimeInterface|null */
     public $releaseDate;
 
     /** @var bool */

src/Issue/Worklog.php

@@ -87,10 +87,13 @@ public function setComment($comment)
         return $this;
     }
 
+    // Note that in the docblock below, you cannot replace `mixed` by `\DateTimeInterface|string` because JsonMapper doesn't support that,
+    // see <https://github.com/cweiske/jsonmapper/issues/64#issuecomment-269545585>.
+
     /**
      * Function to set start time of worklog.
      *
-     * @param mixed $started started time value(\DateTime|string)  e.g. -  new DateTime("2016-03-17 11:15:34") or "2016-03-17 11:15:34"
+     * @param mixed $started started time value(\DateTimeInterface|string)  e.g. -  new \DateTime("2016-03-17 11:15:34") or "2016-03-17 11:15:34"
      *
      * @throws JiraException
      *
@@ -100,10 +103,10 @@ public function setStarted($started)
     {
         if (is_string($started)) {
             $dt = new \DateTime($started);
-        } elseif ($started instanceof \DateTime) {
+        } elseif ($started instanceof \DateTimeInterface) {
             $dt = $started;
         } else {
-            throw new JiraException('field only accept date string or DateTime class.'.get_class($started));
+            throw new JiraException('field only accept date string or DateTimeInterface object.'.get_class($started));
         }
 
         // workround micro second
@@ -115,7 +118,7 @@ public function setStarted($started)
     /**
      * Function to set start time of worklog.
      *
-     * @param \DateTime $started e.g. -  new DateTime("2014-04-05 16:00:00")
+     * @param \DateTimeInterface $started e.g. -  new \DateTime("2014-04-05 16:00:00")
      *
      * @return Worklog
      */

src/JiraClient.php

@@ -81,6 +81,9 @@ public function __construct(ConfigurationInterface $configuration = null, Logger
         // Fix "\JiraRestApi\JsonMapperHelper::class" syntax error, unexpected 'class' (T_CLASS), expecting identifier (T_STRING) or variable (T_VARIABLE) or '{' or '$'
         $this->json_mapper->undefinedPropertyHandler = [new \JiraRestApi\JsonMapperHelper(), 'setUndefinedProperty'];
 
+        // Properties that are annotated with `@var \DateTimeInterface` should result in \DateTime objects being created.
+        $this->json_mapper->classMap['\\'.\DateTimeInterface::class] = \DateTime::class;
+
         // create logger
         if ($logger) {
             $this->log = $logger;

src/Version/VersionService.php

@@ -24,7 +24,7 @@ class VersionService extends \JiraRestApi\JiraClient
      */
     public function create($version)
     {
-        if ($version->releaseDate instanceof \DateTime) {
+        if ($version->releaseDate instanceof \DateTimeInterface) {
             $version->releaseDate = $version->releaseDate->format('Y-m-d');
         }
         $data = json_encode($version);
@@ -88,7 +88,7 @@ public function update(Version $version)
             throw new JiraException($version->id.' is not a valid version id.');
         }
 
-        if ($version->releaseDate instanceof \DateTime) {
+        if ($version->releaseDate instanceof \DateTimeInterface) {
             $version->releaseDate = $version->releaseDate->format('Y-m-d');
         }
 

tests/AssigneeTest.php

@@ -15,6 +15,7 @@ public function setUp()
     {
         $this->mapper = new JsonMapper();
         $this->mapper->undefinedPropertyHandler = [new \JiraRestApi\JsonMapperHelper(), 'setUndefinedProperty'];
+        $this->mapper->classMap['\\'.\DateTimeInterface::class] = \DateTime::class;
     }
 
     public function tearDown()

tests/MapperTest.php

@@ -17,6 +17,7 @@ public function setUp()
     {
         $this->mapper = new JsonMapper();
         $this->mapper->undefinedPropertyHandler = [new \JiraRestApi\JsonMapperHelper(), 'setUndefinedProperty'];
+        $this->mapper->classMap['\\'.\DateTimeInterface::class] = \DateTime::class;
     }
 
     public function tearDown()