mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-02-25 18:45:27 -06:00
Simplify recurring repository.
This commit is contained in:
James Cole
@@ -39,20 +39,20 @@ use FireflyIII\Models\TransactionJournal;
|
|||||||
use FireflyIII\Models\TransactionJournalMeta;
|
use FireflyIII\Models\TransactionJournalMeta;
|
||||||
use FireflyIII\Services\Internal\Destroy\RecurrenceDestroyService;
|
use FireflyIII\Services\Internal\Destroy\RecurrenceDestroyService;
|
||||||
use FireflyIII\Services\Internal\Update\RecurrenceUpdateService;
|
use FireflyIII\Services\Internal\Update\RecurrenceUpdateService;
|
||||||
|
use FireflyIII\Support\Repositories\Recurring\CalculateRangeOccurrences;
|
||||||
|
use FireflyIII\Support\Repositories\Recurring\CalculateXOccurrences;
|
||||||
|
use FireflyIII\Support\Repositories\Recurring\FiltersWeekends;
|
||||||
use FireflyIII\User;
|
use FireflyIII\User;
|
||||||
use Illuminate\Pagination\LengthAwarePaginator;
|
use Illuminate\Pagination\LengthAwarePaginator;
|
||||||
use Illuminate\Support\Collection;
|
use Illuminate\Support\Collection;
|
||||||
use Log;
|
use Log;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
|
||||||
* Class RecurringRepository
|
* Class RecurringRepository
|
||||||
*
|
|
||||||
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
|
|
||||||
* @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
|
|
||||||
*/
|
*/
|
||||||
class RecurringRepository implements RecurringRepositoryInterface
|
class RecurringRepository implements RecurringRepositoryInterface
|
||||||
{
|
{
|
||||||
|
use CalculateRangeOccurrences, CalculateXOccurrences, FiltersWeekends;
|
||||||
/** @var User */
|
/** @var User */
|
||||||
private $user;
|
private $user;
|
||||||
|
|
||||||
@@ -453,451 +453,4 @@ class RecurringRepository implements RecurringRepositoryInterface
|
|||||||
|
|
||||||
return $service->update($recurrence, $data);
|
return $service->update($recurrence, $data);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Filters out all weekend entries, if necessary.
|
|
||||||
*
|
|
||||||
* @param RecurrenceRepetition $repetition
|
|
||||||
* @param array $dates
|
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
|
|
||||||
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
|
|
||||||
*/
|
|
||||||
private function filterWeekends(RecurrenceRepetition $repetition, array $dates): array
|
|
||||||
{
|
|
||||||
if ((int)$repetition->weekend === RecurrenceRepetition::WEEKEND_DO_NOTHING) {
|
|
||||||
Log::debug('Repetition will not be filtered on weekend days.');
|
|
||||||
|
|
||||||
return $dates;
|
|
||||||
}
|
|
||||||
$return = [];
|
|
||||||
/** @var Carbon $date */
|
|
||||||
foreach ($dates as $date) {
|
|
||||||
$isWeekend = $date->isWeekend();
|
|
||||||
if (!$isWeekend) {
|
|
||||||
$return[] = clone $date;
|
|
||||||
Log::debug(sprintf('Date is %s, not a weekend date.', $date->format('D d M Y')));
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
// is weekend and must set back to Friday?
|
|
||||||
if ($repetition->weekend === RecurrenceRepetition::WEEKEND_TO_FRIDAY) {
|
|
||||||
$clone = clone $date;
|
|
||||||
$clone->addDays(5 - $date->dayOfWeekIso);
|
|
||||||
Log::debug(
|
|
||||||
sprintf('Date is %s, and this is in the weekend, so corrected to %s (Friday).', $date->format('D d M Y'), $clone->format('D d M Y'))
|
|
||||||
);
|
|
||||||
$return[] = clone $clone;
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
// postpone to Monday?
|
|
||||||
if ($repetition->weekend === RecurrenceRepetition::WEEKEND_TO_MONDAY) {
|
|
||||||
$clone = clone $date;
|
|
||||||
$clone->addDays(8 - $date->dayOfWeekIso);
|
|
||||||
Log::debug(
|
|
||||||
sprintf('Date is %s, and this is in the weekend, so corrected to %s (Monday).', $date->format('D d M Y'), $clone->format('D d M Y'))
|
|
||||||
);
|
|
||||||
$return[] = $clone;
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
Log::debug(sprintf('Date is %s, removed from final result', $date->format('D d M Y')));
|
|
||||||
}
|
|
||||||
|
|
||||||
// filter unique dates
|
|
||||||
Log::debug(sprintf('Count before filtering: %d', \count($dates)));
|
|
||||||
$collection = new Collection($return);
|
|
||||||
$filtered = $collection->unique();
|
|
||||||
$return = $filtered->toArray();
|
|
||||||
|
|
||||||
Log::debug(sprintf('Count after filtering: %d', \count($return)));
|
|
||||||
|
|
||||||
return $return;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** @noinspection MoreThanThreeArgumentsInspection */
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the number of daily occurrences for a recurring transaction until date $end is reached. Will skip every $skipMod-1 occurrences.
|
|
||||||
*
|
|
||||||
* @param Carbon $start
|
|
||||||
* @param Carbon $end
|
|
||||||
* @param int $skipMod
|
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
private function getDailyInRange(Carbon $start, Carbon $end, int $skipMod): array
|
|
||||||
{
|
|
||||||
$return = [];
|
|
||||||
$attempts = 0;
|
|
||||||
Log::debug('Rep is daily. Start of loop.');
|
|
||||||
while ($start <= $end) {
|
|
||||||
Log::debug(sprintf('Mutator is now: %s', $start->format('Y-m-d')));
|
|
||||||
if (0 === $attempts % $skipMod) {
|
|
||||||
Log::debug(sprintf('Attempts modulo skipmod is zero, include %s', $start->format('Y-m-d')));
|
|
||||||
$return[] = clone $start;
|
|
||||||
}
|
|
||||||
$start->addDay();
|
|
||||||
$attempts++;
|
|
||||||
}
|
|
||||||
|
|
||||||
return $return;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** @noinspection MoreThanThreeArgumentsInspection */
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the number of daily occurrences for a recurring transaction until date $end is reached. Will skip every $skipMod-1 occurrences.
|
|
||||||
*
|
|
||||||
* @param Carbon $start
|
|
||||||
* @param Carbon $end
|
|
||||||
* @param int $skipMod
|
|
||||||
* @param string $moment
|
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
|
|
||||||
*/
|
|
||||||
private function getMonthlyInRange(Carbon $start, Carbon $end, int $skipMod, string $moment): array
|
|
||||||
{
|
|
||||||
$return = [];
|
|
||||||
$attempts = 0;
|
|
||||||
$dayOfMonth = (int)$moment;
|
|
||||||
Log::debug(sprintf('Day of month in repetition is %d', $dayOfMonth));
|
|
||||||
Log::debug(sprintf('Start is %s.', $start->format('Y-m-d')));
|
|
||||||
Log::debug(sprintf('End is %s.', $end->format('Y-m-d')));
|
|
||||||
if ($start->day > $dayOfMonth) {
|
|
||||||
Log::debug('Add a month.');
|
|
||||||
// day has passed already, add a month.
|
|
||||||
$start->addMonth();
|
|
||||||
}
|
|
||||||
Log::debug(sprintf('Start is now %s.', $start->format('Y-m-d')));
|
|
||||||
Log::debug('Start loop.');
|
|
||||||
while ($start < $end) {
|
|
||||||
Log::debug(sprintf('Mutator is now %s.', $start->format('Y-m-d')));
|
|
||||||
$domCorrected = min($dayOfMonth, $start->daysInMonth);
|
|
||||||
Log::debug(sprintf('DoM corrected is %d', $domCorrected));
|
|
||||||
$start->day = $domCorrected;
|
|
||||||
Log::debug(sprintf('Mutator is now %s.', $start->format('Y-m-d')));
|
|
||||||
Log::debug(sprintf('$attempts %% $skipMod === 0 is %s', var_export(0 === $attempts % $skipMod, true)));
|
|
||||||
Log::debug(sprintf('$start->lte($mutator) is %s', var_export($start->lte($start), true)));
|
|
||||||
Log::debug(sprintf('$end->gte($mutator) is %s', var_export($end->gte($start), true)));
|
|
||||||
if (0 === $attempts % $skipMod && $start->lte($start) && $end->gte($start)) {
|
|
||||||
Log::debug(sprintf('ADD %s to return!', $start->format('Y-m-d')));
|
|
||||||
$return[] = clone $start;
|
|
||||||
}
|
|
||||||
$attempts++;
|
|
||||||
$start->endOfMonth()->startOfDay()->addDay();
|
|
||||||
}
|
|
||||||
|
|
||||||
return $return;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** @noinspection MoreThanThreeArgumentsInspection */
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the number of daily occurrences for a recurring transaction until date $end is reached. Will skip every $skipMod-1 occurrences.
|
|
||||||
*
|
|
||||||
* @param Carbon $start
|
|
||||||
* @param Carbon $end
|
|
||||||
* @param int $skipMod
|
|
||||||
* @param string $moment
|
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
private function getNdomInRange(Carbon $start, Carbon $end, int $skipMod, string $moment): array
|
|
||||||
{
|
|
||||||
$return = [];
|
|
||||||
$attempts = 0;
|
|
||||||
$start->startOfMonth();
|
|
||||||
// this feels a bit like a cop out but why reinvent the wheel?
|
|
||||||
$counters = [1 => 'first', 2 => 'second', 3 => 'third', 4 => 'fourth', 5 => 'fifth',];
|
|
||||||
$daysOfWeek = [1 => 'Monday', 2 => 'Tuesday', 3 => 'Wednesday', 4 => 'Thursday', 5 => 'Friday', 6 => 'Saturday', 7 => 'Sunday',];
|
|
||||||
$parts = explode(',', $moment);
|
|
||||||
while ($start <= $end) {
|
|
||||||
$string = sprintf('%s %s of %s %s', $counters[$parts[0]], $daysOfWeek[$parts[1]], $start->format('F'), $start->format('Y'));
|
|
||||||
$newCarbon = new Carbon($string);
|
|
||||||
if (0 === $attempts % $skipMod) {
|
|
||||||
$return[] = clone $newCarbon;
|
|
||||||
}
|
|
||||||
$attempts++;
|
|
||||||
$start->endOfMonth()->addDay();
|
|
||||||
}
|
|
||||||
|
|
||||||
return $return;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the number of daily occurrences for a recurring transaction until date $end is reached. Will skip every $skipMod-1 occurrences.
|
|
||||||
*
|
|
||||||
* @param Carbon $start
|
|
||||||
* @param Carbon $end
|
|
||||||
* @param int $skipMod
|
|
||||||
* @param string $moment
|
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
|
|
||||||
*/
|
|
||||||
private function getWeeklyInRange(Carbon $start, Carbon $end, int $skipMod, string $moment): array
|
|
||||||
{
|
|
||||||
$return = [];
|
|
||||||
$attempts = 0;
|
|
||||||
Log::debug('Rep is weekly.');
|
|
||||||
// monday = 1
|
|
||||||
// sunday = 7
|
|
||||||
$dayOfWeek = (int)$moment;
|
|
||||||
Log::debug(sprintf('DoW in repetition is %d, in mutator is %d', $dayOfWeek, $start->dayOfWeekIso));
|
|
||||||
if ($start->dayOfWeekIso > $dayOfWeek) {
|
|
||||||
// day has already passed this week, add one week:
|
|
||||||
$start->addWeek();
|
|
||||||
Log::debug(sprintf('Jump to next week, so mutator is now: %s', $start->format('Y-m-d')));
|
|
||||||
}
|
|
||||||
// today is wednesday (3), expected is friday (5): add two days.
|
|
||||||
// today is friday (5), expected is monday (1), subtract four days.
|
|
||||||
Log::debug(sprintf('Mutator is now: %s', $start->format('Y-m-d')));
|
|
||||||
$dayDifference = $dayOfWeek - $start->dayOfWeekIso;
|
|
||||||
$start->addDays($dayDifference);
|
|
||||||
Log::debug(sprintf('Mutator is now: %s', $start->format('Y-m-d')));
|
|
||||||
while ($start <= $end) {
|
|
||||||
if (0 === $attempts % $skipMod && $start->lte($start) && $end->gte($start)) {
|
|
||||||
Log::debug('Date is in range of start+end, add to set.');
|
|
||||||
$return[] = clone $start;
|
|
||||||
}
|
|
||||||
$attempts++;
|
|
||||||
$start->addWeek();
|
|
||||||
Log::debug(sprintf('Mutator is now (end of loop): %s', $start->format('Y-m-d')));
|
|
||||||
}
|
|
||||||
|
|
||||||
return $return;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** @noinspection MoreThanThreeArgumentsInspection */
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Calculates the number of daily occurrences for a recurring transaction, starting at the date, until $count is reached. It will skip
|
|
||||||
* over $skipMod -1 recurrences.
|
|
||||||
*
|
|
||||||
* @param Carbon $date
|
|
||||||
* @param int $count
|
|
||||||
* @param int $skipMod
|
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
private function getXDailyOccurrences(Carbon $date, int $count, int $skipMod): array
|
|
||||||
{
|
|
||||||
$return = [];
|
|
||||||
$mutator = clone $date;
|
|
||||||
$total = 0;
|
|
||||||
$attempts = 0;
|
|
||||||
while ($total < $count) {
|
|
||||||
$mutator->addDay();
|
|
||||||
if (0 === $attempts % $skipMod) {
|
|
||||||
$return[] = clone $mutator;
|
|
||||||
$total++;
|
|
||||||
}
|
|
||||||
$attempts++;
|
|
||||||
}
|
|
||||||
|
|
||||||
return $return;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** @noinspection MoreThanThreeArgumentsInspection */
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Calculates the number of monthly occurrences for a recurring transaction, starting at the date, until $count is reached. It will skip
|
|
||||||
* over $skipMod -1 recurrences.
|
|
||||||
*
|
|
||||||
* @param Carbon $date
|
|
||||||
* @param int $count
|
|
||||||
* @param int $skipMod
|
|
||||||
* @param string $moment
|
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
private function getXMonthlyOccurrences(Carbon $date, int $count, int $skipMod, string $moment): array
|
|
||||||
{
|
|
||||||
$return = [];
|
|
||||||
$mutator = clone $date;
|
|
||||||
$total = 0;
|
|
||||||
$attempts = 0;
|
|
||||||
$mutator->addDay(); // always assume today has passed.
|
|
||||||
$dayOfMonth = (int)$moment;
|
|
||||||
if ($mutator->day > $dayOfMonth) {
|
|
||||||
// day has passed already, add a month.
|
|
||||||
$mutator->addMonth();
|
|
||||||
}
|
|
||||||
|
|
||||||
while ($total < $count) {
|
|
||||||
$domCorrected = min($dayOfMonth, $mutator->daysInMonth);
|
|
||||||
$mutator->day = $domCorrected;
|
|
||||||
if (0 === $attempts % $skipMod) {
|
|
||||||
$return[] = clone $mutator;
|
|
||||||
$total++;
|
|
||||||
}
|
|
||||||
$attempts++;
|
|
||||||
$mutator->endOfMonth()->addDay();
|
|
||||||
}
|
|
||||||
|
|
||||||
return $return;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** @noinspection MoreThanThreeArgumentsInspection */
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Calculates the number of NDOM occurrences for a recurring transaction, starting at the date, until $count is reached. It will skip
|
|
||||||
* over $skipMod -1 recurrences.
|
|
||||||
*
|
|
||||||
* @param Carbon $date
|
|
||||||
* @param int $count
|
|
||||||
* @param int $skipMod
|
|
||||||
* @param string $moment
|
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
private function getXNDomOccurrences(Carbon $date, int $count, int $skipMod, string $moment): array
|
|
||||||
{
|
|
||||||
$return = [];
|
|
||||||
$total = 0;
|
|
||||||
$attempts = 0;
|
|
||||||
$mutator = clone $date;
|
|
||||||
$mutator->addDay(); // always assume today has passed.
|
|
||||||
$mutator->startOfMonth();
|
|
||||||
// this feels a bit like a cop out but why reinvent the wheel?
|
|
||||||
$counters = [1 => 'first', 2 => 'second', 3 => 'third', 4 => 'fourth', 5 => 'fifth',];
|
|
||||||
$daysOfWeek = [1 => 'Monday', 2 => 'Tuesday', 3 => 'Wednesday', 4 => 'Thursday', 5 => 'Friday', 6 => 'Saturday', 7 => 'Sunday',];
|
|
||||||
$parts = explode(',', $moment);
|
|
||||||
|
|
||||||
while ($total < $count) {
|
|
||||||
$string = sprintf('%s %s of %s %s', $counters[$parts[0]], $daysOfWeek[$parts[1]], $mutator->format('F'), $mutator->format('Y'));
|
|
||||||
$newCarbon = new Carbon($string);
|
|
||||||
if (0 === $attempts % $skipMod) {
|
|
||||||
$return[] = clone $newCarbon;
|
|
||||||
$total++;
|
|
||||||
}
|
|
||||||
$attempts++;
|
|
||||||
$mutator->endOfMonth()->addDay();
|
|
||||||
}
|
|
||||||
|
|
||||||
return $return;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** @noinspection MoreThanThreeArgumentsInspection */
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Calculates the number of weekly occurrences for a recurring transaction, starting at the date, until $count is reached. It will skip
|
|
||||||
* over $skipMod -1 recurrences.
|
|
||||||
*
|
|
||||||
* @param Carbon $date
|
|
||||||
* @param int $count
|
|
||||||
* @param int $skipMod
|
|
||||||
* @param string $moment
|
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
private function getXWeeklyOccurrences(Carbon $date, int $count, int $skipMod, string $moment): array
|
|
||||||
{
|
|
||||||
$return = [];
|
|
||||||
$total = 0;
|
|
||||||
$attempts = 0;
|
|
||||||
$mutator = clone $date;
|
|
||||||
// monday = 1
|
|
||||||
// sunday = 7
|
|
||||||
$mutator->addDay(); // always assume today has passed.
|
|
||||||
$dayOfWeek = (int)$moment;
|
|
||||||
if ($mutator->dayOfWeekIso > $dayOfWeek) {
|
|
||||||
// day has already passed this week, add one week:
|
|
||||||
$mutator->addWeek();
|
|
||||||
}
|
|
||||||
// today is wednesday (3), expected is friday (5): add two days.
|
|
||||||
// today is friday (5), expected is monday (1), subtract four days.
|
|
||||||
$dayDifference = $dayOfWeek - $mutator->dayOfWeekIso;
|
|
||||||
$mutator->addDays($dayDifference);
|
|
||||||
|
|
||||||
while ($total < $count) {
|
|
||||||
if (0 === $attempts % $skipMod) {
|
|
||||||
$return[] = clone $mutator;
|
|
||||||
$total++;
|
|
||||||
}
|
|
||||||
$attempts++;
|
|
||||||
$mutator->addWeek();
|
|
||||||
}
|
|
||||||
|
|
||||||
return $return;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** @noinspection MoreThanThreeArgumentsInspection */
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Calculates the number of yearly occurrences for a recurring transaction, starting at the date, until $count is reached. It will skip
|
|
||||||
* over $skipMod -1 recurrences.
|
|
||||||
*
|
|
||||||
* @param Carbon $date
|
|
||||||
* @param int $count
|
|
||||||
* @param int $skipMod
|
|
||||||
* @param string $moment
|
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
private function getXYearlyOccurrences(Carbon $date, int $count, int $skipMod, string $moment): array
|
|
||||||
{
|
|
||||||
$return = [];
|
|
||||||
$mutator = clone $date;
|
|
||||||
$total = 0;
|
|
||||||
$attempts = 0;
|
|
||||||
$date = new Carbon($moment);
|
|
||||||
$date->year = $mutator->year;
|
|
||||||
if ($mutator > $date) {
|
|
||||||
$date->addYear();
|
|
||||||
}
|
|
||||||
$obj = clone $date;
|
|
||||||
while ($total < $count) {
|
|
||||||
if (0 === $attempts % $skipMod) {
|
|
||||||
$return[] = clone $obj;
|
|
||||||
$total++;
|
|
||||||
}
|
|
||||||
$obj->addYears(1);
|
|
||||||
$attempts++;
|
|
||||||
}
|
|
||||||
|
|
||||||
return $return;
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the number of daily occurrences for a recurring transaction until date $end is reached. Will skip every $skipMod-1 occurrences.
|
|
||||||
*
|
|
||||||
* @param Carbon $start
|
|
||||||
* @param Carbon $end
|
|
||||||
* @param int $skipMod
|
|
||||||
* @param string $moment
|
|
||||||
*
|
|
||||||
* @return array
|
|
||||||
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
|
|
||||||
*/
|
|
||||||
private function getYearlyInRange(Carbon $start, Carbon $end, int $skipMod, string $moment): array
|
|
||||||
{
|
|
||||||
$attempts = 0;
|
|
||||||
$date = new Carbon($moment);
|
|
||||||
$date->year = $start->year;
|
|
||||||
$return = [];
|
|
||||||
if ($start > $date) {
|
|
||||||
$date->addYear();
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
// is $date between $start and $end?
|
|
||||||
$obj = clone $date;
|
|
||||||
$count = 0;
|
|
||||||
while ($obj <= $end && $obj >= $start && $count < 10) {
|
|
||||||
if (0 === $attempts % $skipMod) {
|
|
||||||
$return[] = clone $obj;
|
|
||||||
}
|
|
||||||
$obj->addYears(1);
|
|
||||||
$count++;
|
|
||||||
$attempts++;
|
|
||||||
}
|
|
||||||
|
|
||||||
return $return;
|
|
||||||
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
203
app/Support/Repositories/Recurring/CalculateRangeOccurrences.php
Normal file
203
app/Support/Repositories/Recurring/CalculateRangeOccurrences.php
Normal file
@@ -0,0 +1,203 @@
|
|||||||
|
<?php
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace FireflyIII\Support\Repositories\Recurring;
|
||||||
|
|
||||||
|
use Carbon\Carbon;
|
||||||
|
use Illuminate\Support\Facades\Log;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Trait CalculateRangeOccurrences
|
||||||
|
*/
|
||||||
|
trait CalculateRangeOccurrences
|
||||||
|
{
|
||||||
|
/** @noinspection MoreThanThreeArgumentsInspection */
|
||||||
|
/**
|
||||||
|
* Get the number of daily occurrences for a recurring transaction until date $end is reached. Will skip every $skipMod-1 occurrences.
|
||||||
|
*
|
||||||
|
* @param Carbon $start
|
||||||
|
* @param Carbon $end
|
||||||
|
* @param int $skipMod
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
protected function getDailyInRange(Carbon $start, Carbon $end, int $skipMod): array
|
||||||
|
{
|
||||||
|
$return = [];
|
||||||
|
$attempts = 0;
|
||||||
|
Log::debug('Rep is daily. Start of loop.');
|
||||||
|
while ($start <= $end) {
|
||||||
|
Log::debug(sprintf('Mutator is now: %s', $start->format('Y-m-d')));
|
||||||
|
if (0 === $attempts % $skipMod) {
|
||||||
|
Log::debug(sprintf('Attempts modulo skipmod is zero, include %s', $start->format('Y-m-d')));
|
||||||
|
$return[] = clone $start;
|
||||||
|
}
|
||||||
|
$start->addDay();
|
||||||
|
$attempts++;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $return;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @noinspection MoreThanThreeArgumentsInspection */
|
||||||
|
/**
|
||||||
|
* Get the number of daily occurrences for a recurring transaction until date $end is reached. Will skip every $skipMod-1 occurrences.
|
||||||
|
*
|
||||||
|
* @param Carbon $start
|
||||||
|
* @param Carbon $end
|
||||||
|
* @param int $skipMod
|
||||||
|
* @param string $moment
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
|
||||||
|
*/
|
||||||
|
protected function getMonthlyInRange(Carbon $start, Carbon $end, int $skipMod, string $moment): array
|
||||||
|
{
|
||||||
|
$return = [];
|
||||||
|
$attempts = 0;
|
||||||
|
$dayOfMonth = (int)$moment;
|
||||||
|
Log::debug(sprintf('Day of month in repetition is %d', $dayOfMonth));
|
||||||
|
Log::debug(sprintf('Start is %s.', $start->format('Y-m-d')));
|
||||||
|
Log::debug(sprintf('End is %s.', $end->format('Y-m-d')));
|
||||||
|
if ($start->day > $dayOfMonth) {
|
||||||
|
Log::debug('Add a month.');
|
||||||
|
// day has passed already, add a month.
|
||||||
|
$start->addMonth();
|
||||||
|
}
|
||||||
|
Log::debug(sprintf('Start is now %s.', $start->format('Y-m-d')));
|
||||||
|
Log::debug('Start loop.');
|
||||||
|
while ($start < $end) {
|
||||||
|
Log::debug(sprintf('Mutator is now %s.', $start->format('Y-m-d')));
|
||||||
|
$domCorrected = min($dayOfMonth, $start->daysInMonth);
|
||||||
|
Log::debug(sprintf('DoM corrected is %d', $domCorrected));
|
||||||
|
$start->day = $domCorrected;
|
||||||
|
Log::debug(sprintf('Mutator is now %s.', $start->format('Y-m-d')));
|
||||||
|
Log::debug(sprintf('$attempts %% $skipMod === 0 is %s', var_export(0 === $attempts % $skipMod, true)));
|
||||||
|
Log::debug(sprintf('$start->lte($mutator) is %s', var_export($start->lte($start), true)));
|
||||||
|
Log::debug(sprintf('$end->gte($mutator) is %s', var_export($end->gte($start), true)));
|
||||||
|
if (0 === $attempts % $skipMod && $start->lte($start) && $end->gte($start)) {
|
||||||
|
Log::debug(sprintf('ADD %s to return!', $start->format('Y-m-d')));
|
||||||
|
$return[] = clone $start;
|
||||||
|
}
|
||||||
|
$attempts++;
|
||||||
|
$start->endOfMonth()->startOfDay()->addDay();
|
||||||
|
}
|
||||||
|
|
||||||
|
return $return;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @noinspection MoreThanThreeArgumentsInspection */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the number of daily occurrences for a recurring transaction until date $end is reached. Will skip every $skipMod-1 occurrences.
|
||||||
|
*
|
||||||
|
* @param Carbon $start
|
||||||
|
* @param Carbon $end
|
||||||
|
* @param int $skipMod
|
||||||
|
* @param string $moment
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
protected function getNdomInRange(Carbon $start, Carbon $end, int $skipMod, string $moment): array
|
||||||
|
{
|
||||||
|
$return = [];
|
||||||
|
$attempts = 0;
|
||||||
|
$start->startOfMonth();
|
||||||
|
// this feels a bit like a cop out but why reinvent the wheel?
|
||||||
|
$counters = [1 => 'first', 2 => 'second', 3 => 'third', 4 => 'fourth', 5 => 'fifth',];
|
||||||
|
$daysOfWeek = [1 => 'Monday', 2 => 'Tuesday', 3 => 'Wednesday', 4 => 'Thursday', 5 => 'Friday', 6 => 'Saturday', 7 => 'Sunday',];
|
||||||
|
$parts = explode(',', $moment);
|
||||||
|
while ($start <= $end) {
|
||||||
|
$string = sprintf('%s %s of %s %s', $counters[$parts[0]], $daysOfWeek[$parts[1]], $start->format('F'), $start->format('Y'));
|
||||||
|
$newCarbon = new Carbon($string);
|
||||||
|
if (0 === $attempts % $skipMod) {
|
||||||
|
$return[] = clone $newCarbon;
|
||||||
|
}
|
||||||
|
$attempts++;
|
||||||
|
$start->endOfMonth()->addDay();
|
||||||
|
}
|
||||||
|
|
||||||
|
return $return;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the number of daily occurrences for a recurring transaction until date $end is reached. Will skip every $skipMod-1 occurrences.
|
||||||
|
*
|
||||||
|
* @param Carbon $start
|
||||||
|
* @param Carbon $end
|
||||||
|
* @param int $skipMod
|
||||||
|
* @param string $moment
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
|
||||||
|
*/
|
||||||
|
protected function getWeeklyInRange(Carbon $start, Carbon $end, int $skipMod, string $moment): array
|
||||||
|
{
|
||||||
|
$return = [];
|
||||||
|
$attempts = 0;
|
||||||
|
Log::debug('Rep is weekly.');
|
||||||
|
// monday = 1
|
||||||
|
// sunday = 7
|
||||||
|
$dayOfWeek = (int)$moment;
|
||||||
|
Log::debug(sprintf('DoW in repetition is %d, in mutator is %d', $dayOfWeek, $start->dayOfWeekIso));
|
||||||
|
if ($start->dayOfWeekIso > $dayOfWeek) {
|
||||||
|
// day has already passed this week, add one week:
|
||||||
|
$start->addWeek();
|
||||||
|
Log::debug(sprintf('Jump to next week, so mutator is now: %s', $start->format('Y-m-d')));
|
||||||
|
}
|
||||||
|
// today is wednesday (3), expected is friday (5): add two days.
|
||||||
|
// today is friday (5), expected is monday (1), subtract four days.
|
||||||
|
Log::debug(sprintf('Mutator is now: %s', $start->format('Y-m-d')));
|
||||||
|
$dayDifference = $dayOfWeek - $start->dayOfWeekIso;
|
||||||
|
$start->addDays($dayDifference);
|
||||||
|
Log::debug(sprintf('Mutator is now: %s', $start->format('Y-m-d')));
|
||||||
|
while ($start <= $end) {
|
||||||
|
if (0 === $attempts % $skipMod && $start->lte($start) && $end->gte($start)) {
|
||||||
|
Log::debug('Date is in range of start+end, add to set.');
|
||||||
|
$return[] = clone $start;
|
||||||
|
}
|
||||||
|
$attempts++;
|
||||||
|
$start->addWeek();
|
||||||
|
Log::debug(sprintf('Mutator is now (end of loop): %s', $start->format('Y-m-d')));
|
||||||
|
}
|
||||||
|
|
||||||
|
return $return;
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Get the number of daily occurrences for a recurring transaction until date $end is reached. Will skip every $skipMod-1 occurrences.
|
||||||
|
*
|
||||||
|
* @param Carbon $start
|
||||||
|
* @param Carbon $end
|
||||||
|
* @param int $skipMod
|
||||||
|
* @param string $moment
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
|
||||||
|
*/
|
||||||
|
protected function getYearlyInRange(Carbon $start, Carbon $end, int $skipMod, string $moment): array
|
||||||
|
{
|
||||||
|
$attempts = 0;
|
||||||
|
$date = new Carbon($moment);
|
||||||
|
$date->year = $start->year;
|
||||||
|
$return = [];
|
||||||
|
if ($start > $date) {
|
||||||
|
$date->addYear();
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
// is $date between $start and $end?
|
||||||
|
$obj = clone $date;
|
||||||
|
$count = 0;
|
||||||
|
while ($obj <= $end && $obj >= $start && $count < 10) {
|
||||||
|
if (0 === $attempts % $skipMod) {
|
||||||
|
$return[] = clone $obj;
|
||||||
|
}
|
||||||
|
$obj->addYears(1);
|
||||||
|
$count++;
|
||||||
|
$attempts++;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $return;
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
203
app/Support/Repositories/Recurring/CalculateXOccurrences.php
Normal file
203
app/Support/Repositories/Recurring/CalculateXOccurrences.php
Normal file
@@ -0,0 +1,203 @@
|
|||||||
|
<?php
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace FireflyIII\Support\Repositories\Recurring;
|
||||||
|
|
||||||
|
|
||||||
|
use Carbon\Carbon;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class CalculateXOccurrences
|
||||||
|
*/
|
||||||
|
trait CalculateXOccurrences
|
||||||
|
{
|
||||||
|
/** @noinspection MoreThanThreeArgumentsInspection */
|
||||||
|
/**
|
||||||
|
* Calculates the number of daily occurrences for a recurring transaction, starting at the date, until $count is reached. It will skip
|
||||||
|
* over $skipMod -1 recurrences.
|
||||||
|
*
|
||||||
|
* @param Carbon $date
|
||||||
|
* @param int $count
|
||||||
|
* @param int $skipMod
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
protected function getXDailyOccurrences(Carbon $date, int $count, int $skipMod): array
|
||||||
|
{
|
||||||
|
$return = [];
|
||||||
|
$mutator = clone $date;
|
||||||
|
$total = 0;
|
||||||
|
$attempts = 0;
|
||||||
|
while ($total < $count) {
|
||||||
|
$mutator->addDay();
|
||||||
|
if (0 === $attempts % $skipMod) {
|
||||||
|
$return[] = clone $mutator;
|
||||||
|
$total++;
|
||||||
|
}
|
||||||
|
$attempts++;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $return;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @noinspection MoreThanThreeArgumentsInspection */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Calculates the number of monthly occurrences for a recurring transaction, starting at the date, until $count is reached. It will skip
|
||||||
|
* over $skipMod -1 recurrences.
|
||||||
|
*
|
||||||
|
* @param Carbon $date
|
||||||
|
* @param int $count
|
||||||
|
* @param int $skipMod
|
||||||
|
* @param string $moment
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
protected function getXMonthlyOccurrences(Carbon $date, int $count, int $skipMod, string $moment): array
|
||||||
|
{
|
||||||
|
$return = [];
|
||||||
|
$mutator = clone $date;
|
||||||
|
$total = 0;
|
||||||
|
$attempts = 0;
|
||||||
|
$mutator->addDay(); // always assume today has passed.
|
||||||
|
$dayOfMonth = (int)$moment;
|
||||||
|
if ($mutator->day > $dayOfMonth) {
|
||||||
|
// day has passed already, add a month.
|
||||||
|
$mutator->addMonth();
|
||||||
|
}
|
||||||
|
|
||||||
|
while ($total < $count) {
|
||||||
|
$domCorrected = min($dayOfMonth, $mutator->daysInMonth);
|
||||||
|
$mutator->day = $domCorrected;
|
||||||
|
if (0 === $attempts % $skipMod) {
|
||||||
|
$return[] = clone $mutator;
|
||||||
|
$total++;
|
||||||
|
}
|
||||||
|
$attempts++;
|
||||||
|
$mutator->endOfMonth()->addDay();
|
||||||
|
}
|
||||||
|
|
||||||
|
return $return;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @noinspection MoreThanThreeArgumentsInspection */
|
||||||
|
/**
|
||||||
|
* Calculates the number of NDOM occurrences for a recurring transaction, starting at the date, until $count is reached. It will skip
|
||||||
|
* over $skipMod -1 recurrences.
|
||||||
|
*
|
||||||
|
* @param Carbon $date
|
||||||
|
* @param int $count
|
||||||
|
* @param int $skipMod
|
||||||
|
* @param string $moment
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
protected function getXNDomOccurrences(Carbon $date, int $count, int $skipMod, string $moment): array
|
||||||
|
{
|
||||||
|
$return = [];
|
||||||
|
$total = 0;
|
||||||
|
$attempts = 0;
|
||||||
|
$mutator = clone $date;
|
||||||
|
$mutator->addDay(); // always assume today has passed.
|
||||||
|
$mutator->startOfMonth();
|
||||||
|
// this feels a bit like a cop out but why reinvent the wheel?
|
||||||
|
$counters = [1 => 'first', 2 => 'second', 3 => 'third', 4 => 'fourth', 5 => 'fifth',];
|
||||||
|
$daysOfWeek = [1 => 'Monday', 2 => 'Tuesday', 3 => 'Wednesday', 4 => 'Thursday', 5 => 'Friday', 6 => 'Saturday', 7 => 'Sunday',];
|
||||||
|
$parts = explode(',', $moment);
|
||||||
|
|
||||||
|
while ($total < $count) {
|
||||||
|
$string = sprintf('%s %s of %s %s', $counters[$parts[0]], $daysOfWeek[$parts[1]], $mutator->format('F'), $mutator->format('Y'));
|
||||||
|
$newCarbon = new Carbon($string);
|
||||||
|
if (0 === $attempts % $skipMod) {
|
||||||
|
$return[] = clone $newCarbon;
|
||||||
|
$total++;
|
||||||
|
}
|
||||||
|
$attempts++;
|
||||||
|
$mutator->endOfMonth()->addDay();
|
||||||
|
}
|
||||||
|
|
||||||
|
return $return;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @noinspection MoreThanThreeArgumentsInspection */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Calculates the number of weekly occurrences for a recurring transaction, starting at the date, until $count is reached. It will skip
|
||||||
|
* over $skipMod -1 recurrences.
|
||||||
|
*
|
||||||
|
* @param Carbon $date
|
||||||
|
* @param int $count
|
||||||
|
* @param int $skipMod
|
||||||
|
* @param string $moment
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
protected function getXWeeklyOccurrences(Carbon $date, int $count, int $skipMod, string $moment): array
|
||||||
|
{
|
||||||
|
$return = [];
|
||||||
|
$total = 0;
|
||||||
|
$attempts = 0;
|
||||||
|
$mutator = clone $date;
|
||||||
|
// monday = 1
|
||||||
|
// sunday = 7
|
||||||
|
$mutator->addDay(); // always assume today has passed.
|
||||||
|
$dayOfWeek = (int)$moment;
|
||||||
|
if ($mutator->dayOfWeekIso > $dayOfWeek) {
|
||||||
|
// day has already passed this week, add one week:
|
||||||
|
$mutator->addWeek();
|
||||||
|
}
|
||||||
|
// today is wednesday (3), expected is friday (5): add two days.
|
||||||
|
// today is friday (5), expected is monday (1), subtract four days.
|
||||||
|
$dayDifference = $dayOfWeek - $mutator->dayOfWeekIso;
|
||||||
|
$mutator->addDays($dayDifference);
|
||||||
|
|
||||||
|
while ($total < $count) {
|
||||||
|
if (0 === $attempts % $skipMod) {
|
||||||
|
$return[] = clone $mutator;
|
||||||
|
$total++;
|
||||||
|
}
|
||||||
|
$attempts++;
|
||||||
|
$mutator->addWeek();
|
||||||
|
}
|
||||||
|
|
||||||
|
return $return;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** @noinspection MoreThanThreeArgumentsInspection */
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Calculates the number of yearly occurrences for a recurring transaction, starting at the date, until $count is reached. It will skip
|
||||||
|
* over $skipMod -1 recurrences.
|
||||||
|
*
|
||||||
|
* @param Carbon $date
|
||||||
|
* @param int $count
|
||||||
|
* @param int $skipMod
|
||||||
|
* @param string $moment
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
protected function getXYearlyOccurrences(Carbon $date, int $count, int $skipMod, string $moment): array
|
||||||
|
{
|
||||||
|
$return = [];
|
||||||
|
$mutator = clone $date;
|
||||||
|
$total = 0;
|
||||||
|
$attempts = 0;
|
||||||
|
$date = new Carbon($moment);
|
||||||
|
$date->year = $mutator->year;
|
||||||
|
if ($mutator > $date) {
|
||||||
|
$date->addYear();
|
||||||
|
}
|
||||||
|
$obj = clone $date;
|
||||||
|
while ($total < $count) {
|
||||||
|
if (0 === $attempts % $skipMod) {
|
||||||
|
$return[] = clone $obj;
|
||||||
|
$total++;
|
||||||
|
}
|
||||||
|
$obj->addYears(1);
|
||||||
|
$attempts++;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $return;
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
78
app/Support/Repositories/Recurring/FiltersWeekends.php
Normal file
78
app/Support/Repositories/Recurring/FiltersWeekends.php
Normal file
@@ -0,0 +1,78 @@
|
|||||||
|
<?php
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace FireflyIII\Support\Repositories\Recurring;
|
||||||
|
|
||||||
|
use Carbon\Carbon;
|
||||||
|
use FireflyIII\Models\RecurrenceRepetition;
|
||||||
|
use Illuminate\Support\Collection;
|
||||||
|
use Illuminate\Support\Facades\Log;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Trait FiltersWeekends
|
||||||
|
*/
|
||||||
|
trait FiltersWeekends
|
||||||
|
{
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Filters out all weekend entries, if necessary.
|
||||||
|
*
|
||||||
|
* @param RecurrenceRepetition $repetition
|
||||||
|
* @param array $dates
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
|
||||||
|
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
|
||||||
|
*/
|
||||||
|
protected function filterWeekends(RecurrenceRepetition $repetition, array $dates): array
|
||||||
|
{
|
||||||
|
if ((int)$repetition->weekend === RecurrenceRepetition::WEEKEND_DO_NOTHING) {
|
||||||
|
Log::debug('Repetition will not be filtered on weekend days.');
|
||||||
|
|
||||||
|
return $dates;
|
||||||
|
}
|
||||||
|
$return = [];
|
||||||
|
/** @var Carbon $date */
|
||||||
|
foreach ($dates as $date) {
|
||||||
|
$isWeekend = $date->isWeekend();
|
||||||
|
if (!$isWeekend) {
|
||||||
|
$return[] = clone $date;
|
||||||
|
Log::debug(sprintf('Date is %s, not a weekend date.', $date->format('D d M Y')));
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
// is weekend and must set back to Friday?
|
||||||
|
if ($repetition->weekend === RecurrenceRepetition::WEEKEND_TO_FRIDAY) {
|
||||||
|
$clone = clone $date;
|
||||||
|
$clone->addDays(5 - $date->dayOfWeekIso);
|
||||||
|
Log::debug(
|
||||||
|
sprintf('Date is %s, and this is in the weekend, so corrected to %s (Friday).', $date->format('D d M Y'), $clone->format('D d M Y'))
|
||||||
|
);
|
||||||
|
$return[] = clone $clone;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
// postpone to Monday?
|
||||||
|
if ($repetition->weekend === RecurrenceRepetition::WEEKEND_TO_MONDAY) {
|
||||||
|
$clone = clone $date;
|
||||||
|
$clone->addDays(8 - $date->dayOfWeekIso);
|
||||||
|
Log::debug(
|
||||||
|
sprintf('Date is %s, and this is in the weekend, so corrected to %s (Monday).', $date->format('D d M Y'), $clone->format('D d M Y'))
|
||||||
|
);
|
||||||
|
$return[] = $clone;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
Log::debug(sprintf('Date is %s, removed from final result', $date->format('D d M Y')));
|
||||||
|
}
|
||||||
|
|
||||||
|
// filter unique dates
|
||||||
|
Log::debug(sprintf('Count before filtering: %d', \count($dates)));
|
||||||
|
$collection = new Collection($return);
|
||||||
|
$filtered = $collection->unique();
|
||||||
|
$return = $filtered->toArray();
|
||||||
|
|
||||||
|
Log::debug(sprintf('Count after filtering: %d', \count($return)));
|
||||||
|
|
||||||
|
return $return;
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user