Skip to content

doublehelix/php-time-ago

 
 

Repository files navigation

Inspired by the comments at: http://dk.php.net/time and http://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html#M001695

Using this scheme to determine the “ago” time:


  0 <-> 29 secs                                                             # => less than a minute
  30 secs <-> 1 min, 29 secs                                                # => 1 minute
  1 min, 30 secs <-> 44 mins, 29 secs                                       # => [2..44] minutes
  44 mins, 30 secs <-> 89 mins, 29 secs                                     # => about 1 hour
  89 mins, 29 secs <-> 23 hrs, 59 mins, 29 secs                             # => about [2..24] hours
  23 hrs, 59 mins, 29 secs <-> 47 hrs, 59 mins, 29 secs                     # => 1 day
  47 hrs, 59 mins, 29 secs <-> 29 days, 23 hrs, 59 mins, 29 secs            # => [2..29] days
  29 days, 23 hrs, 59 mins, 30 secs <-> 59 days, 23 hrs, 59 mins, 29 secs   # => about 1 month
  59 days, 23 hrs, 59 mins, 30 secs <-> 1 yr minus 1 sec                    # => [2..12] months
  1 yr <-> 2 yrs minus 1 secs                                               # => about 1 year
  2 yrs <-> max time or date                                                # => over [2..X] years

Changes since last version

Lots have changed since the last version. The WWDateTime class is no longer supported.
I have implemented a new class which takes a time string as parameter (and a
timezone if needed), and calculates the time between them.

By request from “lsolesen” (a guy from here on github) I did removed the whole
DateTime dependence thingy.

About

This class is here to give you the same functionality that DateTime::diff will give you.
However, this will work with PHP versions lower than 5.3.0

This code is also available on Packagist: https://packagist.org/packages/jimmiw/php-time-ago

Two methods instead of just one!

There are now two methods you can call: (well, 3, but two important ones!)


$timeAgo = new TimeAgo();
echo $timeAgo->inWords("2010/1/10 23:05:00");

// OR

echo timeAgoInWords("2010/1/10 23:05:00");

Both methods gives the same answer, the “timeAgoInWords()” function is just a
convenience wrapper for you.

Do you want the actual years, months, days, hours, minutes, seconds difference?

Good news for you then!
I’ve implemented a nice little function that does just that for you. Simply do the
following:


$timeAgo = new TimeAgo();
$dateDifferenceArray =  $timeAgo->dateDifference("2010/1/10 23:05:00");

This will return an array with the following data:


array(
);

Translations added

You can now translate the texts returned using the $timeAgo→inWords() or timeAgoInWords() methods.
The translation is simply a language code string added to the end of the class init or timeAgoInWords() method.

Examples using the Danish translations:


$timeZone = NULL; // just use the system timezone

$timeAgo = new TimeAgo($timeZone, 'da');
echo $timeAgo->inWords("2010/1/10 23:05:00");

// OR

echo timeAgoInWords("2010/1/10 23:05:00", $timeZone, 'da');

Changes (versions)

0.4.11: Changes to French translation (souhailmerroun). Added Russian and Ukranian translations (akavolkol)
0.4.10: Added Korean and Finnish translations (thanks to @easylogic and @tk1sul1)
0.4.9: Added Spanish and Hungarian and Brazilian Portuguese (thanks to @khrizt and @technodelight and @gugoan)
0.4.8: Added French and Japanese and Taiwanese translations (thanks to @barohatoum and @hotengchang)
0.4.7: Changes to fix annoying “floor” bugs.
0.4.6: Added Dutch and Chinese translations (thanks to @NielsdeBlaauw and @su-xiaolin)
0.4.5: Fix for wrongly named variable – patch from @rimager
0.4.4: Changed the previous fix, since it caused a problem with the “Scheme” at the start of this document. “about 1 hour ago” is between 44mins30secs and 89mins29secs.
0.4.3: Added a fix for “about 1 hour ago”, which would yield “1 hours ago” if the time was 1hour 30minutes. Giving a pluralization error.
0.4.2: Added German translations .
0.4.1: Added “ago” to the end of the translations, so the texts now read “about 1 hour ago”.
0.4.0: Added translations (Danish and English) to the plugin.

The old way of doing things.

Just if you wanted to try out the old “time ago” class, I’ve kept it in the project.
It will eventually be deleted, but hey, go have fun with it. Perhaps even extend it etc.
Bear in mind though, that the new DateTime::diff in PHP version 5.3.0 will eventually
replace it completely. (PHP 5.3.0 DateTime::diff link: http://www.php.net/manual/en/datetime.diff.php)

Known bugs

  • dateDifference() calculates a bit wrong when finding differences over 1 year.

The MIT License

Copyright © 2014 Jimmi Westerberg (http://westsworld.dk)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

About

Simple module, that displays the date in a "time ago" format.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 100.0%