minor #39892 [Uid] Clarify the format returned by getTime() (fancyweb)

jderusse · jderusse · commit 2c8368f59277 · 2021-01-19T15:45:30.000+01:00
This PR was merged into the 5.1 branch. Discussion ---------- [Uid] Clarify the format returned by getTime() | Q | A | ------------- | --- | Branch? | 5.1 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - I think adding a comment to explain the returned format is useful here, especially for uuid since their "normal" epoch is not the unix epoch. Commits ------- c14c737 [Uid] Clarify the format returned by getTime()
diff --git a/src/Symfony/Component/Uid/Ulid.php b/src/Symfony/Component/Uid/Ulid.php
@@ -104,6 +104,9 @@ public function toBase32(): string
         return $this->uid;
     }
 
+    /**
+     * @return float Seconds since the Unix epoch 1970-01-01 00:00:00
+     */
     public function getTime(): float
     {
         $time = strtr(substr($this->uid, 0, 10), 'ABCDEFGHJKMNPQRSTVWXYZ', 'abcdefghijklmnopqrstuv');
diff --git a/src/Symfony/Component/Uid/UuidV1.php b/src/Symfony/Component/Uid/UuidV1.php
@@ -31,6 +31,9 @@ public function __construct(string $uuid = null)
         }
     }
 
+    /**
+     * @return float Seconds since the Unix epoch 1970-01-01 00:00:00
+     */
     public function getTime(): float
     {
         $time = '0'.substr($this->uid, 15, 3).substr($this->uid, 9, 4).substr($this->uid, 0, 8);
diff --git a/src/Symfony/Component/Uid/UuidV6.php b/src/Symfony/Component/Uid/UuidV6.php
@@ -32,6 +32,9 @@ public function __construct(string $uuid = null)
         }
     }
 
+    /**
+     * @return float Seconds since the Unix epoch 1970-01-01 00:00:00
+     */
     public function getTime(): float
     {
         $time = '0'.substr($this->uid, 0, 8).substr($this->uid, 9, 4).substr($this->uid, 15, 3);

Original file line number	Diff line number	Diff line change
`@@ -104,6 +104,9 @@ public function toBase32(): string`
`104`	`104`	`return $this->uid;`
`105`	`105`	`}`
`106`	`106`
	`107`	`+ /**`
	`108`	`+ * @return float Seconds since the Unix epoch 1970-01-01 00:00:00`
	`109`	`+ */`
`107`	`110`	`public function getTime(): float`
`108`	`111`	`{`
`109`	`112`	`$time = strtr(substr($this->uid, 0, 10), 'ABCDEFGHJKMNPQRSTVWXYZ', 'abcdefghijklmnopqrstuv');`
Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,9 @@ public function __construct(string $uuid = null)`
`31`	`31`	`}`
`32`	`32`	`}`
`33`	`33`
	`34`	`+ /**`
	`35`	`+ * @return float Seconds since the Unix epoch 1970-01-01 00:00:00`
	`36`	`+ */`
`34`	`37`	`public function getTime(): float`
`35`	`38`	`{`
`36`	`39`	`$time = '0'.substr($this->uid, 15, 3).substr($this->uid, 9, 4).substr($this->uid, 0, 8);`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,9 @@ public function __construct(string $uuid = null)`
`32`	`32`	`}`
`33`	`33`	`}`
`34`	`34`
	`35`	`+ /**`
	`36`	`+ * @return float Seconds since the Unix epoch 1970-01-01 00:00:00`
	`37`	`+ */`
`35`	`38`	`public function getTime(): float`
`36`	`39`	`{`
`37`	`40`	`$time = '0'.substr($this->uid, 0, 8).substr($this->uid, 9, 4).substr($this->uid, 15, 3);`