openpsa / ranger
Formatter for date and time ranges with i18n support
Installs: 121 941
Dependents: 3
Suggesters: 0
Security: 0
Stars: 73
Watchers: 4
Forks: 15
Open Issues: 2
Requires
- php: >=7.0
- symfony/intl: ~2.6|~3.4|~4.0|~5.0|~6.0|~7.0
Requires (Dev)
- phpunit/phpunit: >=6.5
Suggests
- ext-intl: Needed for usage with other locales than 'en'
README
Ranger is a formatter for date and time ranges, based (somewhat loosely) on Adam Shaw's formatRange
algorithm in fullCalendar.
Some Examples
<?php use OpenPsa\Ranger\Ranger; $ranger = new Ranger('en'); echo $ranger->format('2013-10-05', '2013-10-20'); // Oct 5–20, 2013 echo $ranger->format('2013-10-05', '2013-11-20'); // Oct 5 – Nov 20, 2013 $ranger = new Ranger('en_GB'); echo $ranger->format('2013-10-05', '2013-10-20'); // 5–20 Oct 2013 echo $ranger->format('2013-10-05', '2013-11-20'); // 5 Oct – 20 Nov 2013 $ranger = new Ranger('de'); echo $ranger->format('2013-10-05', '2013-10-20'); // 05.–20.10.2013 echo $ranger->format('2013-10-05', '2013-11-20'); // 05.10.–20.11.2013
Usage
To use Ranger in any other locale than "en"
, you will need to have the php-intl
extension installed.
Instantiate ranger with the name of your locale as the parameter. You can also pass null
to use the ini.default_locale
setting. Afterwards, you can call format()
with two date parameters. Accepted types are
DateTime
objects- strings (any format that
DateTime
can read) - Unix timestamps
null
(which means current date).
Output Customization
<?php use OpenPsa\Ranger\Ranger; use IntlDateFormatter; $ranger = new Ranger('en'); $ranger ->setRangeSeparator(' and ') ->setDateTimeSeparator(', between ') ->setDateType(IntlDateFormatter::LONG) ->setTimeType(IntlDateFormatter::SHORT); echo $ranger->format('2013-10-05 10:00:01', '2013-10-05 13:30:00'); // October 5, 2013, between 10:00 AM and 1:30 PM