tochka-developers/work-calendar

Russian Federation production calendar extension for Carbon

Maintainers

Details

github.com/tochka-developers/work-calendar

Source

Issues

Installs: 9 799

Dependents: 0

Suggesters: 0

Security: 0

Stars: 15

Watchers: 6

Forks: 0

Open Issues: 0

Type:package

v2.3.0 2024-11-02 07:07 UTC

Requires

Requires (Dev)

MIT a2a74ed3cdc96677b62047d317cca6e2cb38dd0d

  • Ivanov Sergey <ivanov.woop@tochka.com>

This package is auto-updated.

Last update: 2024-12-02 07:22:35 UTC

README

Описание

Класс-хелпер позволяет удобно работать с производственным календарем. По-умолчанию, настроен производственный календарь РФ без учета региональных праздников. Расширяет функционал Carbon\Carbon.

Установка

С использованием composer:

$ composer require tochka-developers/work-calendar

Использование

Методы для удобной работы с производственным календарем:

  • isWorkday(): bool - true, если день рабочий, иначе false;
  • diffInWorkdays(WorkCalendar $carbon): int - разница в рабочих днях между двумя датами. Может возвращать отрицательное значение, если передаваемая дата меньше(раньше) текущей;
  • addWorkday() - добавить рабочий день к текущей дате. То есть экземпляр будет хранить следующий рабочий день вместо установленного дня;
  • subWorkday() - отнять рабочий день от текущей даты. То есть экземпляр будет хранить предыдущий рабочий день вместо установленного дня;
  • addWorkdays(int $count) - добавить $count рабочих дней к текущей дате;
  • subWorkdays(int $count) - отнять $count рабочих дней от текущей даты.

Примеры использования

$date = WorkCalendar::create('2018', '02', '22');
print_r($date->isWorkday()); // true
...
$date->addDay(); // 2018-02-23, день защитника отечества
print_r($date->isWorkday()); // false
...
$date->addWorkday();
print_r($date->format('Y-m-d') // 2018-02-26
...
$date->subWorkday();
print_r($date->format('Y-m-d') // 2018-02-22
...
$date->addWorkdays(5);
print_r($date->format('Y-m-d') // 2018-03-02
...
$date->subWorkdays(5);
print_r($date->format('Y-m-d') // 2018-02-22

Собственный производственный календарь

Если есть необходимость в учете региональных праздников, либо создать производственный календарь для другой страны, то это можно сделать следующим образом:

  • Унаследовать функциональность класса Tochka\Calendar\AbstractYearMaskProvider собственным классом и переопределить метод generateYearMask(). Данный метод должен возвращать маску рабочих и выходных дней в виде массива, где 1 - это рабочий день, а 0 - праздничный. Количество элементов должно быть равно количеству дней в году;
  • В Tochka\Calendar\WorkCalendar::setMaskProvider() передать экземпляр вновь созданного класса;
  • Готово, можно пользоваться WorkCalendar.

Источники