debuss-a/business-datetime

A DateTime implementation to help you calculate DateTime in business days.

Maintainers

Details

github.com/debuss/business-datetime

Source

Issues

Installs: 1

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

1.0.0 2023-04-25 16:43 UTC

Requires

  • php: ^8.0

Requires (Dev)

MIT 33e43bac0abab7689a4eccce17df65a987f4c5ef

  • Alexandre DEBUSSCHÈRE <alexandre.debusschere.woop@hey.com>

This package is auto-updated.

Last update: 2024-08-25 19:52:34 UTC

README

Business DateTime

A DateTime implementation to help you calculate DateTime in business days.

Report Bug · Request Feature

Table of Contents
  1. Getting Started
  2. Usage
  3. Contributing
  4. License
  5. Acknowledgments

Getting Started

Use composer to add this package to your project.

Prerequisites

  • PHP v8+

Installation

In your project root folder:

composer require debuss-a/business-datetime

(back to top)

Usage

You can define a starting date, setup working days and holidays, then add a number of business day to your starting date.

You'll easily be able to know the exact date you need in business days.

use Business\DateTime\BusinessDateTime;

$business_day = new BusinessDateTime('2023-04-25');
$business_day
    ->setNonBusinessDays([
        BusinessDateTime::SATURDAY,
        BusinessDateTime::SUNDAY
    ])
    // Or
    // ->setWorkingDays([
    //     BusinessDateTime::MONDAY,
    //     BusinessDateTime::TUESDAY,
    //     BusinessDateTime::WEDNESDAY,
    //     BusinessDateTime::THURSDAY,
    //     BusinessDateTime::FRIDAY
    // ])
    ->setHolidays([
        new DateTime('2023-05-01'),
        new DateTime('2023-05-08')
    ])
    ->addBusinessDays(14);

var_dump($business_day->format('Y-m-d'));
// --> 2023-05-17

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE file for more information.

(back to top)

Acknowledgments

(back to top)