README

A Laravel wrapper for the Nager.Date API that provides information about public holidays and weekend data.

Requirements

PHP 7.3 or higher
Laravel 8.0, 9.0, 10.0, 11.0, or 12.0
Guzzle HTTP 7.0 or higher

Installation

You can install the package via composer:

composer require rolle-marketplace/nager-date-laravel

The package will automatically register its service provider.

You can publish the configuration file with:

php artisan vendor:publish --provider="RolleMarketplace\NagerDateLaravel\NagerDateServiceProvider" --tag="config"

This will publish a nager-date.php file in your config directory.

Usage

Basic Usage

// Using the facade
use RolleMarketplace\NagerDateLaravel\Facades\NagerDate;
use RolleMarketplace\NagerDateLaravel\Enums\CountryCode;

// Get all public holidays for 2023 in the United States
$holidays = NagerDate::getPublicHolidays(2023, CountryCode::US);

// Check if a specific date is a public holiday
$isHoliday = NagerDate::isPublicHoliday(CountryCode::US, 2023, 12, 25); // Christmas day

// Get all countries available in the API
$countries = NagerDate::getAvailableCountries();

// Check if a specific date is a weekend
$isWeekend = NagerDate::isWeekend(2023, 12, 23); // Saturday

Available Methods

Get Available Countries

Returns a Collection of CountryDTO objects with all available countries in the API.

$countries = NagerDate::getAvailableCountries();

Get Public Holidays

Returns a Collection of PublicHolidayDTO objects with all public holidays for a specific year and country.

$holidays = NagerDate::getPublicHolidays(2023, CountryCode::US);

Get Public Holidays With Weekend

Returns a Collection of PublicHolidayDTO objects with all public holidays including weekend information.

$holidays = NagerDate::getPublicHolidaysWithWeekend(2023, CountryCode::US);

Check if a Date is a Public Holiday

Returns a boolean indicating if a specific date is a public holiday in the given country.

$isHoliday = NagerDate::isPublicHoliday(CountryCode::US, 2023, 12, 25);

Get Long Weekends

Returns a Collection of LongWeekendDTO objects with all long weekends for a specific year and country.

$longWeekends = NagerDate::getLongWeekend(2023, CountryCode::US);

Get Country Info

Returns a CountryDTO object with information about a specific country.

$countryInfo = NagerDate::getCountryInfo(CountryCode::US);

Check if a Date is a Weekend

Returns a boolean indicating if a specific date is a weekend.

$isWeekend = NagerDate::isWeekend(2023, 12, 23);

Response DTOs

All API responses are mapped to Data Transfer Objects (DTOs) for easy use:

CountryDTO

countryCode: string
name: string

PublicHolidayDTO

date: string (ISO 8601 date format)
localName: string
name: string
countryCode: string
fixed: boolean
global: boolean
launchYear: string|null
types: array

LongWeekendDTO

startDate: string (ISO 8601 date format)
endDate: string (ISO 8601 date format)
dayCount: integer
needBridgeDay: boolean

Testing

composer test

License

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

rolle-marketplace / nager-date-laravel

Maintainers

Details