Merge branch 'master' of github.com:jimmiw/php-time-ago

Author: Jimmi Westerberg

.gitignore

@@ -1,2 +1,3 @@
+composer.lock
 vendor
 report

Changelog.md

@@ -2,6 +2,8 @@
 
 ### 3.1.0
 * Changed from psr-0 to psr-4, since some language classes could not be loaded properly
+* Added support for DateTimeImmutable objects, thanks to @xtreamwayz
+* Added Indonesian translation, thanks to @dhutapratama
 
 ### 3.0.6
 * Fixed #79 where 1h30m would be 1 hours ago instead of 2 hours ago

README.md

@@ -117,12 +117,16 @@ The translation is simply a language code string added to the end of the class i
 Examples using the Danish translations:
 
 ```
-$timeZone = null; // just use the system timezone
+$myLang = new \Westsworld\TimeAgo\Translations\Da();
 
-$timeAgo = new Westsworld\TimeAgo($timeZone, 'da'); // default language is en (english)
+$timeAgo = new Westsworld\TimeAgo($myLang); // default language is en (english)
 echo $timeAgo->inWords("2010/1/10 23:05:00");
 ```
 
+# Available translation languages
+
+You can view the file of available list inside /src/Westsworld/TimeAgo/Translations/ folder.
+
 # Changelog
 
 For a full list of changes, please see Changelog.md

src/Westsworld/TimeAgo.php

@@ -3,8 +3,9 @@
 namespace Westsworld;
 
 // just making life easier :)
-use Exception;
 use DateTime;
+use DateTimeInterface;
+use Exception;
 // importing the language class
 use Westsworld\TimeAgo\Language;
 use Westsworld\TimeAgo\Translations\En;
@@ -65,11 +66,11 @@ protected function getLanguage(): Language
 
     /**
      * Fetches the different between $past and $now in a spoken format.
-     * @param DateTime $past the past date to use
-     * @param DateTime $now the current time, defaults to now, using timezone from $past
+     * @param DateTimeInterface $past the past date to use
+     * @param DateTimeInterface $now the current time, defaults to now, using timezone from $past
      * @return string the time difference in a spoken format, e.g. 1 day ago
      */
-    public function inWords(DateTime $past, DateTime $now = null)
+    public function inWords(DateTimeInterface $past, DateTimeInterface $now = null)
     {
         // ensuring that "now" is a DateTime object, using the past's timeZone
         // if needed, to create a new now object.
@@ -95,12 +96,12 @@ public function inWordsFromStrings(string $past, string $now = 'now')
     /**
      * Fetches the date difference between the two given dates.
      *
-     * @param DateTime $past the "past" time to parse
-     * @param DateTime $now the "now" time to parse
+     * @param DateTimeInterface $past the "past" time to parse
+     * @param DateTimeInterface $now the "now" time to parse
      * @return array the difference in dates, using the two dates
      * @deprecated 3.0.0 this method is not really needed anymore, since DateTime can do it
      */
-    public function dateDifference(DateTime $past, DateTime $now = null)
+    public function dateDifference(DateTimeInterface $past, DateTimeInterface $now = null)
     {
         $now = $this->getNow($past, $now);
 
@@ -119,11 +120,11 @@ public function dateDifference(DateTime $past, DateTime $now = null)
     /**
      * Fetches the given $now variable, but initializes it if it's null
      *
-     * @param DateTime $past the past tiem
-     * @param DateTime $now the now to use or initialize
-     * @return DateTime $now initialized, if it was not, else the original object
+     * @param DateTimeInterface $past the past tiem
+     * @param DateTimeInterface $now the now to use or initialize
+     * @return DateTimeInterface $now initialized, if it was not, else the original object
      */
-    public function getNow(DateTime $past, DateTime $now = null): DateTime
+    public function getNow(DateTimeInterface $past, DateTimeInterface $now = null): DateTimeInterface
     {
         // handles cases where $now is null
         if (null === $now) {

src/Westsworld/TimeAgo/Language.php

@@ -2,8 +2,9 @@
 
 namespace Westsworld\TimeAgo;
 
-use \DateTime;
-use \DateInterval;
+use DateInterval;
+use DateTime;
+use DateTimeInterface;
 
 abstract class Language
 {
@@ -42,13 +43,13 @@ public function hasTranslation($key): bool
 
     /**
      * Fetches the different between $past and $now in a spoken format.
-     * NOTE: both past and now should be instances of DateTime
+     * NOTE: both past and now should be instances of DateTimeInterface
      *
-     * @param DateTime $past the past date to use
-     * @param DateTime $now the current timezone, defaults to now.
+     * @param DateTimeInterface $past the past date to use
+     * @param DateTimeInterface $now the current timezone, defaults to now.
      * @return string the difference in spoken format, e.g. 1 day ago
      */
-    public function inWords(DateTime $past, DateTime $now)
+    public function inWords(DateTimeInterface $past, DateTimeInterface $now)
     {
         // finds the time difference as a string
         return $this->getTimeDifference($past->diff($now));
@@ -141,7 +142,7 @@ private function getTimeDifference(DateInterval $timeDifference)
     /**
      * Checks if the given past is empty
      *
-     * @param DateTime $past the "past" to check
+     * @param DateTimeInterface $past the "past" to check
      * @return bool true if empty, else false
      */
     // private function isPastEmpty($past)
@@ -251,7 +252,7 @@ private function isLessThan23Hours59Mins29Seconds(DateInterval $timeDifference)
         ) {
             return $timeDifference->s < 30;
         }
-            
+
         return ! $this->isLessThan1Hour29Mins59Seconds($timeDifference);
     }
 
@@ -300,7 +301,7 @@ private function isLessThan29Days23Hours59Mins29Seconds(DateInterval $timeDiffer
         ) {
             return $timeDifference->s <= 29;
         }
-            
+
         return ! $this->isLessThan23Hours59Mins29Seconds($timeDifference);
     }
 
@@ -324,7 +325,7 @@ private function isLessThan59Days23Hours59Mins29Secs(DateInterval $timeDifferenc
         ) {
             return $timeDifference->s <= 29;
         }
-            
+
         return ! $this->isLessThan29Days23Hours59Mins29Seconds($timeDifference);
     }
 

src/Westsworld/TimeAgo/Translations/Id.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Westsworld\TimeAgo\Translations;
+
+use \Westsworld\TimeAgo\Language;
+
+/**
+ * Indonesian translations
+ */
+class Id extends Language
+{
+    public function __construct()
+    {
+        $this->setTranslations([
+            'aboutOneDay' => "1 hari",
+            'aboutOneHour' => "1 jam",
+            'aboutOneMonth' => "1 bulan",
+            'aboutOneYear' => "1 tahun",
+            'days' => "%s hari",
+            'hours' => "%s jam",
+            'lessThanAMinute' => "Baru saja",
+            'lessThanOneHour' => "%s menit",
+            'months' => "%s bulan",
+            'oneMinute' => "1 menit",
+            'years' => "%s tahun",
+            'never' => 'Tidak pernah'
+        ]);
+    }
+}

tests/TimeagoTest.php

@@ -2,10 +2,11 @@
 
 namespace Westsworld\TimeAgo\Tests;
 
-use Westsworld\TimeAgo;
-use PHPUnit\Framework\TestCase;
-use DateTime;
 use DateInterval;
+use DateTime;
+use DateTimeImmutable;
+use PHPUnit\Framework\TestCase;
+use Westsworld\TimeAgo;
 
 /**
  * Testing timeago dates
@@ -42,7 +43,7 @@ public function testTimeAgoInWords()
         $this->assertEquals('1 minute ago', $timeAgo->inWordsFromStrings("-60 second"));
         $this->assertEquals('1 minute ago', $timeAgo->inWordsFromStrings("-89 second"));
         $this->assertNotEquals('1 minute ago', $timeAgo->inWordsFromStrings("-90 second"));
-        
+
 
         // testing 2..44 minutes
         $this->assertContains('minutes ago', $timeAgo->inWordsFromStrings("-2 minute"));
@@ -111,7 +112,7 @@ public function testTimeAgoInWords()
     public function testTimeAgoInWordsDateTime()
     {
         $timeAgo = new TimeAgo(new \Westsworld\TimeAgo\Translations\En());
-        
+
         // testing "less than a minute"
         $this->assertEquals('less than a minute ago', $timeAgo->inWords(new DateTime()));
         $this->assertEquals('less than a minute ago', $timeAgo->inWords((new DateTime())->sub(new DateInterval('PT1S'))));
@@ -125,6 +126,23 @@ public function testTimeAgoInWordsDateTime()
         $this->assertNotEquals('1 minute ago', $timeAgo->inWords((new DateTime())->sub(new DateInterval('PT90S'))));
     }
 
+    public function testTimeAgoInWordsDateTimeImmutable()
+    {
+        $timeAgo = new TimeAgo(new \Westsworld\TimeAgo\Translations\En());
+
+        // testing "less than a minute"
+        $this->assertEquals('less than a minute ago', $timeAgo->inWords(new DateTimeImmutable()));
+        $this->assertEquals('less than a minute ago', $timeAgo->inWords((new DateTimeImmutable())->sub(new DateInterval('PT1S'))));
+        $this->assertEquals('less than a minute ago', $timeAgo->inWords((new DateTimeImmutable())->sub(new DateInterval('PT29S'))));
+        $this->assertNotEquals('less than a minute ago', $timeAgo->inWords((new DateTimeImmutable())->sub(new DateInterval('PT30S'))));
+
+        // testing "1 minute"
+        $this->assertEquals('1 minute ago', $timeAgo->inWords((new DateTimeImmutable())->sub(new DateInterval('PT30S'))));
+        $this->assertEquals('1 minute ago', $timeAgo->inWords((new DateTimeImmutable())->sub(new DateInterval('PT60S'))));
+        $this->assertEquals('1 minute ago', $timeAgo->inWords((new DateTimeImmutable())->sub(new DateInterval('PT89S'))));
+        $this->assertNotEquals('1 minute ago', $timeAgo->inWords((new DateTimeImmutable())->sub(new DateInterval('PT90S'))));
+    }
+
     public function testLanguage()
     {
         // using default (english)