README

PHP library for generating recurring dates for schedules, repeated tasks, and calendar-like recurrence rules.

Supports daily, weekly, monthly, and yearly recurrences with custom intervals, end conditions, skipped dates, and Carbon or DateTimeInterface inputs.

Useful for:

• recurring tasks
• recurring events
• appointment schedules
• reminder schedules
• repeated billing dates
• calendar-style date generation

Installation

You can install the package via composer:

composer require wilianx7/php-recurring

Features

• Generate recurring dates for daily, weekly, monthly, and yearly schedules
• Set recurrence end rules with NEVER, IN, or AFTER
• Skip specific dates with exceptDates
• Optionally include the start date in the generated collection
• Use Carbon, DateTime, or DateTimeImmutable in configuration

Basic usage

RecurringConfig accepts any DateTimeInterface in its date setters, so you can use Carbon, DateTime, or DateTimeImmutable.

• Configuration for every day recurrence ending never:

$startDate = new DateTimeImmutable('2019-12-26 08:00:00');
$endDate = new DateTimeImmutable('2019-12-31 23:59:59');

$recurringConfig = new RecurringConfig();

$recurringConfig->setStartDate($startDate)
    ->setFrequencyType(FrequencyTypeEnum::DAY())
    ->setFrequencyInterval(1)
    ->setFrequencyEndType(FrequencyEndTypeEnum::NEVER())
    ->setEndDate($endDate);

$dates = RecurringBuilder::forConfig($recurringConfig)->startRecurring();

• Configuration for weekly recurrence (Monday and Sunday) ending after 5 occurrences:

$recurringConfig = new RecurringConfig();

$recurringConfig->setStartDate(new DateTimeImmutable('2019-01-01 08:00:00'))
    ->setFrequencyType(FrequencyTypeEnum::WEEK())
    ->setFrequencyInterval(1)
    ->setFrequencyEndType(FrequencyEndTypeEnum::AFTER())
    ->setFrequencyEndValue(5)
    ->setRepeatIn([WeekdayEnum::MONDAY(), WeekdayEnum::SUNDAY()])
    ->setEndDate(new DateTimeImmutable('2019-12-31 23:59:59'));

$dates = RecurringBuilder::forConfig($recurringConfig)->startRecurring();

• Configuration for monthly recurrence (day 27) ending in 2019-11-30:

$recurringConfig = new RecurringConfig();

$recurringConfig->setStartDate(new DateTimeImmutable('2019-01-01 08:00:00'))
    ->setFrequencyType(FrequencyTypeEnum::MONTH())
    ->setFrequencyInterval(1)
    ->setFrequencyEndType(FrequencyEndTypeEnum::IN())
    ->setFrequencyEndValue(new DateTimeImmutable('2019-11-30 00:00:00'))
    ->setRepeatIn(27)
    ->setEndDate(new DateTimeImmutable('2019-12-31 23:59:59'));

$dates = RecurringBuilder::forConfig($recurringConfig)->startRecurring();

• Configuration for yearly recurrence (day 27 and month 10) ending in 2019-11-30:

$recurringConfig = new RecurringConfig();

$recurringConfig->setStartDate(new DateTimeImmutable('2019-01-01 08:00:00'))
    ->setFrequencyType(FrequencyTypeEnum::YEAR())
    ->setFrequencyInterval(1)
    ->setFrequencyEndType(FrequencyEndTypeEnum::IN())
    ->setFrequencyEndValue(new DateTimeImmutable('2019-11-30 00:00:00'))
    ->setRepeatIn(['day' => 27, 'month' => 10])
    ->setEndDate(new DateTimeImmutable('2019-12-31 23:59:59'));

$dates = RecurringBuilder::forConfig($recurringConfig)->startRecurring();

Recurring Config

• includeStartDate: By default, the start date is not included in the return array, as it assumes that this date is already in use, requiring only the return of subsequent dates. However, you can override this behavior by setting "includeStartDate" property as true.

Recurring Builder

Enums

Testing

composer run test