Download the PHP package wilianx7/php-recurring without Composer
On this page you can find all versions of the php package wilianx7/php-recurring. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download wilianx7/php-recurring
More information about wilianx7/php-recurring
Files in wilianx7/php-recurring
Download wilianx7/php-recurring
More information about wilianx7/php-recurring
Files in wilianx7/php-recurring
Vendor wilianx7
Package php-recurring
Short Description PHP library to make getting dates easier when working with recurring tasks.
License MIT
Homepage https://github.com/wilianx7/php-recurring
Package php-recurring
Short Description PHP library to make getting dates easier when working with recurring tasks.
License MIT
Homepage https://github.com/wilianx7/php-recurring
Please rate this library. Is it a good library?
Informations about the package php-recurring
PHP Recurring
PHP library to make getting dates easier when working with recurring tasks.
Installation
You can install the package via composer:
Basic usage
-
Configuration for every day recurrence ending never:
-
Configuration for weekly recurrence (Monday and Sunday) ending after 5 occurrences:
-
Configuration for monthly recurrence (day 27) ending in 2019-11-30:
- Configuration for yearly recurrence (day 27 and month 10) ending never:
Recurring Config
Attribute | Description | Default |
---|---|---|
startDate |
Date the search will start for find the dates the recurrence should be generated. | Start of current year |
endDate |
Date the search for the dates will ended. | End of current year |
frequencyType |
How often the recurrence will be generated accord of the enum FrequencyTypeEnum. Can be setted as: DAY, WEEK, MONTH or YEAR. | FrequencyTypeEnum::DAY() |
frequencyInterval |
Determines the interval between recurrences according to the chosen frequency type. | 1 |
repeatIn |
Determines when recurrence should be generated according to the frequency type chosen. Can be setted, for example, as: null (for DAY); [ WeekdayEnum::MONDAY(), WeekdayEnum::SUNDAY() ] (for WEEK); 31 (for MONTH); ['day' => 31, 'month' => 2] (for YEAR)." | Null |
frequencyEndType |
Determines what will be the stopping criterion for recurrence generation according of the enum FrequencyEndTypeEnum. Can be setted as: NEVER, IN or AFTER. | FrequencyEndTypeEnum::NEVER() |
frequencyEndValue |
Determines a value according to the chosen stop criterion. Can be setted, for example, as: null (for NEVER); 3 (for AFTER); Carbon::now() (for IN). | Null |
lastRepeatedDate |
Date the last recurrence was generated. It is used to avoid unnecessary date generation by calling the generation method more than once. | Null |
repeatedCount |
How many recurrences have already been generated. It is used to avoid unnecessary date generation by calling the generation method more than once. | Null |
exceptDates |
Dates when recurrence should not be generated even if the date conforms to the specified setting. Accepts native array or Laravel Collection. | Null |
includeStartDate |
Defines whether the start date should be included in the return array | false |
- 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
Method | Description | Return |
---|---|---|
forConfig |
Used to construct the recurrence according to setting passed by parameter. | Self |
startRecurring |
Start generating dates for recurrence | A collection with all the dates generated |
Enums
Enum | Values |
---|---|
FrequencyEndTypeEnum |
NEVER, IN, AFTER |
FrequencyTypeEnum |
DAY, WEEK, MONTH, YEAR |
WeekdayEnum |
SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY |
Testing
All versions of php-recurring with dependencies
PHP Build Version
Package Version
The package wilianx7/php-recurring contains the following files
Loading the files please wait ....