PHPackages jasonjgardner/date-range - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. jasonjgardner/date-range ActiveLibrary jasonjgardner/date-range ======================== Simple date ranges for PHP 7.1|8.0 1.1.0(7y ago)14291MITPHPPHP ^7.1 Since Oct 9Pushed 4y ago1 watchersCompare [ Source](https://github.com/jasonjgardner/date-range)[ Packagist](https://packagist.org/packages/jasonjgardner/date-range)[ Docs](https://github.com/jasonjgardner/date-range)[ RSS](/packages/jasonjgardner-date-range/feed)WikiDiscussions master Synced today READMEChangelogDependencies (1)Versions (4)Used By (0) DateRange ========= [](#daterange) Simple Date Range Object for PHP **7.1|8.0** ***Earlier PHP versions**: Check out the original [DateRange](https://github.com/brtriver/date-range) by [brtriver](https://github.com/brtriver/).* Requirements ------------ [](#requirements) PHP 7.1.0 or later Install ------- [](#install) Install using [Composer](https://packagist.org/packages/jasonjgardner/date-range): ``` $ composer require jasonjgardner/date-range ``` Usage ----- [](#usage) ### Creating date ranges [](#creating-date-ranges) Create a date range object which contains a start `\DateTime` and an end `\DateTime`: ``` use jasonjgardner\DateRange\DateRange; $summer = new DateRange('2017-06-20', '2017-09-22'); echo 'Summer starts on ', $summer->getStartDate()->format('F j, Y'); /// Summer starts on June 21, 2017 echo 'The last day of summer is ', $summer->getEndDate()->format('F j, Y'); /// The last day of summer is September 22, 2017 ``` Pass a variety of variable types to the constructor: ``` /// Accepts `\DateTime` objects new DateRange(new \DateTime('today'), new \DateTime('tomorrow')); /// Accepts date strings new DateRange('2017-09-15', '10-15-2017'); /// Accepts timestamps $DateRange = new DateRange(1493886600, '1499172300'); echo $DateRange->toString('m/d/Y'); /// 05/04/2017 - 07/04/2017 /// Accepts an array of dates $dates = [ '2017-10-21', '2017-01-01', '2017-12-31', '2017-10-31' ]; $DateRange = new DateRange($dates); echo $DateRange->getStartDate()->format('M j'); /// Jan 1 echo $DateRange->getEndDate()->format('M j'); /// Dec 31 /// Only requires a start date argument $DateRange = new DateRange('12/31/2017'); echo $DateRange->getEndDate()->format('M j, Y G:i e'); /// Jan 1, 2018 0:00 UTC /// Create dates in a certain timezone $date = new \DateTime( 'March 1, 2017 3:30 PM', new \DateTimeZone('America/New_York') ); $DateRange = new DateRange( $date, null, new \DateTimeZone('Asia/Tokyo') ); echo $DateRange->getStartDate()->format('M j, Y G:i e'); /// March 2, 2017 4:30 AM Asia/Tokyo ``` ### Date range comparisons [](#date-range-comparisons) Check if a certain date comes before, after, or is during a date range: ``` $aries = new DateRange('March 21', 'April 19'); $birthday = new \DateTime('April 1'); if ($aries->compare($birthday) === 0) { echo 'You are an Aries ♈'; } else if ($aries->compare('March 1') < 0) { echo 'You look like a Pisces ♓'; } else if ($aries->compare('May 1') > 0) { echo 'Are you a Taurus? ♉'; } ``` > The `DateRange::compare()` method compares a date string, object, or timestamp against the start and end dates in the date range. It will return **-1** if the date is *before* the date range, 0 if the date is *during* the date range, or **1** if the date is *after* the date range. > The class constants `DateRange::COMPARE_BEFORE`, `DateRange::COMPARE_BETWEEN`, and `DateRange::COMPARE_AFTER` are set to -1, 0, and 1 (respectively). #### Differences [](#differences) Find the difference between the start and end dates: ``` $DateRange = new DateRange('Nov 4', 'Nov 8'); echo $DateRange->diff()->format('%d days); /// 4 days ``` ### Date range output [](#date-range-output) Convert date range to string and format date output: ``` $LaborDayWeekend = new DateRange('August 31, 2018', 'September 3, 2018'); echo $LaborDayWeekend->toString('m-d-Y'); /// 08-31-2018 - 09-03-2018 echo $LaborDayWeekend->toString('m-d-Y', 'Y-n-j'); /// 08-31-2018 - 2018-9-3 echo (string) $LaborDayWeekend; /// 2018-08-31 - 2018-09-03 ``` #### Date range as array [](#date-range-as-array) Iterating over the `$LaborDayWeekend` date range defined in the previous example: ``` foreach ($LaborDayWeekend as $day) { echo $day->format('M j, Y'); /// Aug 31, 2018 /// Sep 1, 2018 /// Sep 2, 2018 /// Sep 3, 2018 } ``` Converting to an array of formatted date strings: ``` $week = new DateRange('Sunday', 'Saturday'); $days = $week->toArray('l'); /// $days = ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'] ``` ### Excluding dates [](#excluding-dates) The class constants `DateRange::EXCLUDE_END_DATE` and `DateRange::EXCLUDE_START_DATE` can be passed to the following methods to omit the start or end date from the results: - `DateRange::getDatePeriod($interval, $exclude)` - `DateRange::compare($date, $exclude)` - `DateRange::toArray($format, $short, $interval, $exclude)` In a `DateRange` which spans from Sunday to Saturday, the `EXCLUDE_*` constants can be passed as the `$exclude`parameter, individually or together with a bitwise operator, to modify the range like so: `DateRange` OptionStartEnd(without constants)SundaySaturday`EXCLUDE_START_DATE`MondaySaturday`EXCLUDE_END_DATE`SundayFriday`EXCLUDE_START_DATE` | `EXCLUDE_END_DATE`MondayFridayLicense ------- [](#license) DateRange is licensed under the MIT license. ### Health Score 29 — LowBetter than 60% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity15 Limited adoption so far Community10 Small or concentrated contributor base Maturity60 Established project with proven stability Bus Factor1 Top contributor holds 93.8% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~117 days Total 3 Last Release 2902d ago PHP version history (2 changes)v1.0.0PHP >=7.1.0 1.1.0PHP ^7.1 ### Community Maintainers ![](https://www.gravatar.com/avatar/4ecb44b1db5cb8062146a83f0f3eb949f0340d20736f8df681bed1849c6cb175?d=identicon)[-jason](/maintainers/-jason) --- Top Contributors [![jasonjgardner](https://avatars.githubusercontent.com/u/1903667?v=4)](https://github.com/jasonjgardner "jasonjgardner (15 commits)")[![blackiceua](https://avatars.githubusercontent.com/u/12099886?v=4)](https://github.com/blackiceua "blackiceua (1 commits)") --- Tags composer-packagedatetimephp71datedatesdate-range ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/jasonjgardner-date-range/health.svg) ``` [![Health](https://phpackages.com/badges/jasonjgardner-date-range/health.svg)](https://phpackages.com/packages/jasonjgardner-date-range) ``` ### Alternatives [cakephp/chronos A simple API extension for DateTime. 1.4k47.7M121](/packages/cakephp-chronos)[simshaun/recurr PHP library for working with recurrence rules 1.6k15.7M40](/packages/simshaun-recurr)[nesbot/carbon An API extension for DateTime that supports 281 different languages. 169661.4M4.8k](/packages/nesbot-carbon)[azuyalabs/yasumi The easy PHP Library for calculating holidays 1.1k11.4M26](/packages/azuyalabs-yasumi)[carbonphp/carbon-doctrine-types Types to use Carbon in Doctrine 213220.4M8](/packages/carbonphp-carbon-doctrine-types)[kartik-v/yii2-date-range An advanced Yii 2 date range picker input for based on bootstrap-daterangepicker plugin. 894.4M42](/packages/kartik-v-yii2-date-range) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)