ecommit / frequency-generator
Get the next date by frequency.
Installs: 6 168
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 1
Open Issues: 0
Requires
- php: ^7.2|^8.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.0
- phpunit/phpunit: ^8.4
- vimeo/psalm: ^4.23
This package is auto-updated.
Last update: 2024-10-30 14:52:12 UTC
README
Get the next date (DateTime object) by frequency.
Installation
To install frequency-generator with Composer just run :
$ composer require ecommit/frequency-generator
Usage
Create generator
use Ecommit\FrequencyGenerator\FrequencyGenerator; $generator = new FrequencyGenerator();
Frequency "every day"
//Every day at 08:00:00 and 10:00:00 $dateTimeObject = $generator->nextInEveryDay([new \DateTime('10:00:00'), new \DateTime('08:00:00')]);
Arguments :
- array $times Times (Array of DateTime or DateTimeImmutable objects). Default: only 00:00:00
Frequency "every week"
//Every monday (at 08:00:00 and 10:00:00) and tuesday (at 08:00:00 and 10:00:00) $dateTimeObject = $generator->nextInEveryWeek([1, 2], [new \DateTime('10:00:00'), new \DateTime('08:00:00')]);
Arguments :
- array $days Array of days in week (integers). (1=Monday => 7=Sunday). Default: Only 1 (monday)
- array $times Times (Array of DateTime or DateTimeImmutable objects). Default: only 00:00:00
Frequency "every month"
//Every 1st (at 08:00:00 and 10:00:00) and 2nd (at 08:00:00 and 10:00:00) $dateTimeObject = $generator->nextInEveryMonth([1, 2], [new \DateTime('10:00:00'), new \DateTime('08:00:00')]);
Arguments :
- array $days Array of days in month (integers). (1=>31). Default: Only 1 (1st)
- array $times Times (Array of DateTime or DateTimeImmutable objects). Default: only 00:00:00
Frequency "every quart"
//Every 1st and 15th February, May, August and November (at 08:00:00 and 10:00:00) $dateTimeObject = $generator->nextInEveryQuart([2], [1, 15], [new \DateTime('10:00:00'), new \DateTime('08:00:00')]);
Arguments :
- array $monthOffsets Array of month offsets in quart (integers). (1 = January, April, July, October. 2 = February, May, August, November. 3 = March, June, September, December). Default: Only 1 (January, April, July, October)
- array $daysInMonth Array of days in month (integers). (1=>31). Default: Only 1 (1st)
- array $times Times (Array of DateTime or DateTimeImmutable objects). Default: only 00:00:00
Frequency "every half year"
//Every 1st and 15th February and August (at 08:00:00 and 10:00:00) $dateTimeObject = $generator->nextInEveryHalfYear([2], [1, 15], [new \DateTime('10:00:00'), new \DateTime('08:00:00')]);
- array $monthOffsets Array of month offsets in half year (integers). 1 = January, July. 2 = February, August. 3 = March, September. 4 = April, October. 5 = May , November. 6 = June, December). Default: Only 1 (January, July)
- array $daysInMonth Array of days in month (integers). (1=>31). Default: Only 1 (1st)
- array $times Times (Array of DateTime or DateTimeImmutable objects). Default: only 00:00:00
Frequency "every year"
//Every 1st and 15th January (at 08:00:00 and 10:00:00) $dateTimeObject = $generator->nextInEveryYear([1], [1, 15], [new \DateTime('10:00:00'), new \DateTime('08:00:00')]);
- array $monthOffsets Array of month offsets in year (integers). (1 = January => 12 => December). Default: Only 1 (January)
- array $daysInMonth Array of days in month (integers). (1=>31). Default: Only 1 (1st)
- array $times Times (Array of DateTime or DateTimeImmutable objects). Default: only 00:00:00
Generate DateTimeImmutable objects
The generator generates by default DateTime objects.
The generator can generate DateTimeImmutable objets with generateDateTimeImmutable
method:
use Ecommit\FrequencyGenerator\FrequencyGenerator; $generator = new FrequencyGenerator(); $date = $generator->nextInEveryDay([new \DateTime('10:00:00'), new \DateTime('08:00:00')]); echo get_class($date); //This example will output "DateTime" $generator->generateDateTimeImmutable(true); $date = $generator->nextInEveryDay([new \DateTime('10:00:00'), new \DateTime('08:00:00')]); echo get_class($date); //This example will output "DateTimeImmutable" $generator->generateDateTimeImmutable(false); $date = $generator->nextInEveryDay([new \DateTime('10:00:00'), new \DateTime('08:00:00')]); echo get_class($date); //This example will output "DateTime"
License
This librairy is under the MIT license. See the complete license in LICENSE file.