serhiicho / ago

Converts given date into a nice readable format. Supports multiple languages. Example will be "1 hour ago", "2 days ago", "1 second ago", "Online" and so on.

Date/time converter into "n time ago" format that supports multiple languages, such as 🇷🇺 🇬🇧 🇳🇱 🇺🇦 🇩🇪. You can contribute any language that you wish easily by creating a pull request. When new PHP version comes out, this package will be updated to support it as soon as possible.

This package is well tested, optimized and already used in many production apps. It has shown itself pretty well. If you find any issues or bugs 🐞, please create an issue, and I'll fix it as soon as I can.

Follow the official documentation for more information

🚀 Quick Start

composer require serhii/ago

License

The Ago project is licensed under the MIT License

ago's Issues

Remove Option::UPCOMING in version v3.0.0

Option Option::UPCOMING is deprecated in version v2.3.0. It needs to be removed in the next major release, which is version v3.0.0.

Add ability to overwrite any translation fields

Lang::set() method has to except custom translations as the second argument.

Lang::set('en', [
    'day' => 'Day',
    'days' => 'Days',
]);

Go from static classes to objects

Change all static method to objects, and make all of them singletons.

Changed string options

Instead of passing array of string options it has to be constant variables. If you pass 1 variable then you don't need to wrap it in array

TimeAgo::trans($date, NO_SUFFIX)
TimeAgo::trans($date, [NO_SUFFIX, UPCOMMING])

Add Ukrainian language support

Split Russian and English tests

Add ability for trans() method to except different types of arguments

TimeAgo::trans() excepts only string as the first argument. Add ability for trans() method to except timestamp, DateTime object, Carbon and CarbonImmutable.

TimeAgo::trans('now - 10 seconds'); // output: 10 seconds ago

TimeAgo::trans(new DateTime('now - 1 day')); // output should be: 1 day ago

TimeAgo::trans(time()); // output should be: 0 seconds ago

TimeAgo::trans(CarbonImmutable::now()); // output should be: 0 seconds ago

TimeAgo::trans(Carbon::now()); // output should be: 0 seconds ago

Renamed Time package to TimeAgo

Renamed main package to make it more descriptive.

Rename ago() method in TimeAgo class to trans().

Make easy way to add new language

Make that if you want to make add new language, all you need is to add single file to lang directory with all translations without changing anything else.

🇮🇳 Contribute translation to Indian language

Intro

Indian language is very popular in programming world because there are countless developers out there and many applications written in PHP programming language. I want to add Indian language support for this package, but I don't have a knowledge of Indian.

Todo

If you are a software developer who knows language PHP and you want to contribute to Open source, feel free to add Indian language support for this ago package. Here is the 📄 documentation for contributing a translation. Please follow the instructions there.

If there is anything you don't understand in 📄 CONTRINUTE.md guide, or it lacks of information, let me know, and I'll make sure to add more detailed information.

Add uppercase option

🇳🇱 Contribute translation to Dutch language

Intro

Dutch language is very popular in programming world because there are many developers out there and many applications written in PHP programming language. I want to add Dutch language support for this package, but I don't have a knowledge of Dutch.

Todo

If you are a software developer who knows language PHP and you want to contribute to Open source, feel free to add Dutch language support for this ago package. Here is the 📄 documentation for contributing a translation. Please follow the instructions there.

🇨🇳 Contribute translation to Chinese language

Intro

Chinese language is very popular in programming world because there are countless developers out there and many applications written in PHP programming language. I want to add Chinese language support for this package, but I don't have a knowledge of Chinese.

Todo

If you are a software developer who knows language PHP and you would like to contribute to Open source, feel free to add Chinese language support for this ago package. Here is the 📄 documentation for contributing a translation. Please follow the instructions there.

If there is anything you don't understand in 📄 CONTRINUTE.md guide, or it lacks of information, let me know, and I'll make sure to add more detailed information.

Make trans() function more flexible

Currently, if you pass the past date to the trans() function, it will return date in x time ago format. If you pass the date from future, it will return 0 seconds ago.

We need to change that behavior in the next version, so that instead of 0 seconds ago it will return interval to that given date. For example, if now is 1 January 2023, and we pass the date 1 January 2024, it should return 1 year. So basically, we need to deprecate the option Option::UPCOMING and make it as a default behavior if you passed a future date.

It will be a nice improvement because before you had to give a Option::UPCOMING flag, but after the update the program will check if the given date is a future date, then use Option::UPCOMING. If the date is in the past, don't use the flag UPCOMING.

This functionality will allows us to use it for showing future dates. One case can be if you need to show how long is to wait to a certain event in the future.