README

Retrieve start and end dates for calendar or fiscal quarters for any year with ease!

Installation

You can install the package via composer:

composer require gtmassey/quarter

This package is an extension of the gtmassey/period package. You can find the documentation for that package here.

Usage

The package provides a Quarter class which contains static methods for each quarter of a year, and additional methods that can be chained on that allow for mutations of the quarter to specific years, calendar types, and dates.

//Jan 1, YYYY - Mar 31, YYYY
Quarter::first();

//Apr 1, YYYY - Jun 30, YYYY
Quarter::second();

//Jul 1, YYYY - Sep 30, YYYY
Quarter::third();

//Oct 1, YYYY - Dec 31, YYYY
Quarter::fourth();

As an extension of the Period class from gtmassey/period, the resulting Quarter object is structured the same way:

Gtmassey\Quarter\Quarter {#6221
  +startDate: Carbon\CarbonImmutable @1672531200 {#6224
    date: 2023-01-01 00:00:00.0 UTC (+00:00),
  },
  +endDate: Carbon\CarbonImmutable @1680307199 {#6220
    date: 2023-03-31 23:59:59.999999 UTC (+00:00),
  },
}

Specifying Years

If you want to specify the year of the quarter, you can chain the year() method on the quarter. Note that you have to format the year as YYYY. If you don't, it will take the year literally, i.e. the year 0020.

//Jan 1, 2020 - Mar 31, 2020
Quarter::first()->year(2020);

//Jan 1, 0020 - Mar 31, 0020
Quarter::first()->year(20);

//Jan 1, 1995 - Mar 31, 1995
Quarter::first()->year(1995);

Changing the Resulting Object

By default, the Quarter class returns a Quarter object. You can default to the parent Period object by calling the asPeriod() method:

Quarter::first()->asPeriod();

which will result in an instance of Period like so:

Gtmassey\Period\Period {
  +startDate: Carbon\CarbonImmutable @1672531200 {
    date: 2023-01-01 00:00:00.0 UTC (+00:00),
  },
  +endDate: Carbon\CarbonImmutable @1680307199 {
    date: 2023-03-31 23:59:59.999999 UTC (+00:00),
  },
}

Changing Calendar Types

So far, the quarter methods have been assuming a calendar year for the quarter dates. If you want to use the fiscal year in which the first quarter starts on July 1, you can chain the toFiscal() method:

//July 1, YYYY - September 30, YYYY
Quarter::first()->toFiscal();

You can chain the year() and toFiscal() methods together:

//July 1, 1995 - September 30, 1995
Quarter::first()->year(1995)->toFiscal();

and if you want the resulting object to be an instance of the parent Period class, you can chain the asPeriod() method:

//July 1, 1995 - September 30, 1995
Quarter::first()->year(1995)->toFiscal()->asPeriod();

The toFiscal() method creates a new Quarter instance that is 6 months ahead of the current Quarter.

//Jan 1, YYYY - Mar 31, YYYY
Quarter::first();

//Jul 1, YYYY - Sep 30, YYY
Quarter::first()->toFiscal();

If you wish to convert the current Quarter instance into a fiscal representation, you can use the asFiscal() method.

The difference between toFiscal() and asFiscal() is that the asFiscal() keeps the start and end dates the same, it just changes the instance's name to be the correct representation in a fiscal calendar.

//Jul 1, YYYY - Sep 30, YYYY
//Q3
Quarter::third();

//Jul 1, YYYY - Sep 30, YYYY
//Q1
Quarter::first()->toFiscal();

Using the asFiscal() method preserves the start and end dates of the quarter, but changes the name and isFiscal properties on the object.

Start and End Dates Only

Sometimes you only need to access the start and end dates of a given quarter, without accessing the entire range. To do that, simply add the startDate() or endDate() method to the chain:

//July 1, 2020
Quarter::third()->year(20)->startDate();

Past and Future Quarters:

If you have a given quarter object, and you want to get the next quarter, you can use the next() method:

$quarter = Quarter::first()->year(2020);
//Jan 1, 2020 - Mar 31, 2020
$next = $quarter->next();
//Apr 1, 2020 - Jun 30, 2020

To get the previous quarters from a given Quarter object, use the previous() method:

$quarter = Quarter::first()->year(2020);
//Jan 1, 2020 - Mar 31, 2020
$previous = $quarter->previous();
//Oct 1, 2019 - Dec 31, 2019

Finally, you can access the current quarter by calling the current() method:

$current = Quarter::current();
//return the dates for the current quarter, regardless of calendar or fiscal dates.

Laravel Note:

The parent Period class is written specifically for Laravel because it is an extracted package from the gtmassey/laravel-analytics package. However, the Quarter class does not need Laravel to function. If you want to use the Quarter class in Laravel, you can add the class to your config/app.php aliases array:

'aliases' => Facade::defaultAliases()->merge([
    // 'Example' => App\Facades\Example::class,
    'Quarter' => Gtmassey\Quarter\Quarter::class,
])->toArray(),

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

To contribute, fork the repo, create a new branch, and submit a pull request. I will do my best to review them in a timely manner.

License

The MIT License (MIT). Please see License File for more information.

gtmassey / quarter

Maintainers

Details