https://github.com/florianv/business
:date: DateTime calculations in business hours
https://github.com/florianv/business
business-hours date opening-hours php
Last synced: 9 months ago
JSON representation
:date: DateTime calculations in business hours
- Host: GitHub
- URL: https://github.com/florianv/business
- Owner: florianv
- License: mit
- Created: 2015-05-25T23:35:02.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2022-06-13T07:53:26.000Z (over 3 years ago)
- Last Synced: 2025-05-13T21:06:14.483Z (9 months ago)
- Topics: business-hours, date, opening-hours, php
- Language: PHP
- Homepage: http://florianv.github.io/business
- Size: 73.2 KB
- Stars: 362
- Watchers: 8
- Forks: 27
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Business [![Build status][travis-image]][travis-url] [![Version][version-image]][version-url] [![PHP Version][php-version-image]][php-version-url]
> DateTime calculations in business hours
## Installation
```bash
$ composer require florianv/business
```
## Usage
First you need to configure your business schedule:
```php
use Business\SpecialDay;
use Business\Day;
use Business\Days;
use Business\Business;
use Business\Holidays;
use Business\DateRange;
// Opening hours for each week day. If not specified, it is considered closed
$days = [
// Standard days with fixed opening hours
new Day(Days::MONDAY, [['09:00', '13:00'], ['2pm', '5 PM']]),
new Day(Days::TUESDAY, [['9 AM', '5 PM']]),
new Day(Days::WEDNESDAY, [['10:00', '13:00'], ['14:00', '17:00']]),
new Day(Days::THURSDAY, [['10 AM', '5 PM']]),
// Special day with dynamic opening hours depending on the date
new SpecialDay(Days::FRIDAY, function (\DateTime $date) {
if ('2015-05-29' === $date->format('Y-m-d')) {
return [['9 AM', '12:00']];
}
return [['9 AM', '5 PM']];
}),
];
// Optional holiday dates
$holidays = new Holidays([
new \DateTime('2015-01-01'),
new \DateTime('2015-01-02'),
new DateRange(new \DateTime('2015-07-08'), new \DateTime('2015-07-11')),
]);
// Optional business timezone
$timezone = new \DateTimeZone('Europe/Paris');
// Create a new Business instance
$business = new Business($days, $holidays, $timezone);
```
### Methods
##### within() - Tells if a date is within business hours
```php
$bool = $business->within(new \DateTime('2015-05-11 10:00'));
```
##### timeline() - Returns a timeline of business dates
```php
$start = new \DateTime('2015-05-11 10:00');
$end = new \DateTime('2015-05-14 10:00');
$interval = new \DateInterval('P1D');
$dates = $business->timeline($start, $end, $interval);
```
##### closest() - Returns the closest business date from a given date
```php
// After that date (including it)
$nextDate = $business->closest(new \DateTime('2015-05-11 10:00'));
// Before that date (including it)
$lastDate = $business->closest(new \DateTime('2015-05-11 10:00'), Business::CLOSEST_LAST);
```
### Serialization
#### PHP serialization
The `Business` class can be serialized so it can be stored for later reuse:
```php
$serialized = serialize($business);
$business = unserialize($serialized);
```
If you use `SpecialDay` instances, you need to install the `jeremeamia/superclosure` library providing closure serialization:
```bash
$ composer require jeremeamia/superclosure
```
#### JSON serialization
All classes can be encoded to JSON
```php
$json = json_encode($business);
```
The `SpecialDay` instances require a context in order extract the data from the callable.
This is automatically set to `new \DateTime('now')` for `json_encode()` call only.
## License
[MIT](https://github.com/florianv/business/blob/master/LICENSE)
[travis-url]: https://travis-ci.org/florianv/business
[travis-image]: http://img.shields.io/travis/florianv/business.svg?style=flat
[version-url]: https://packagist.org/packages/florianv/business
[version-image]: http://img.shields.io/packagist/v/florianv/business.svg?style=flat
[php-version-url]: https://packagist.org/packages/florianv/business
[php-version-image]: http://img.shields.io/badge/php-5.4+-ff69b4.svg