mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-09-05 20:22:07 +00:00
371 lines
14 KiB
PHP
371 lines
14 KiB
PHP
<?php
|
|
/**
|
|
* RecurringRepository.php
|
|
* Copyright (c) 2018 thegrumpydictator@gmail.com
|
|
*
|
|
* This file is part of Firefly III.
|
|
*
|
|
* Firefly III is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Firefly III is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace FireflyIII\Repositories\Recurring;
|
|
|
|
use Carbon\Carbon;
|
|
use FireflyIII\Exceptions\FireflyException;
|
|
use FireflyIII\Factory\RecurrenceFactory;
|
|
use FireflyIII\Models\Note;
|
|
use FireflyIII\Models\Preference;
|
|
use FireflyIII\Models\Recurrence;
|
|
use FireflyIII\Models\RecurrenceRepetition;
|
|
use FireflyIII\User;
|
|
use Illuminate\Support\Collection;
|
|
|
|
|
|
/**
|
|
*
|
|
* Class RecurringRepository
|
|
*/
|
|
class RecurringRepository implements RecurringRepositoryInterface
|
|
{
|
|
/** @var User */
|
|
private $user;
|
|
|
|
/**
|
|
* Returns all of the user's recurring transactions.
|
|
*
|
|
* @return Collection
|
|
*/
|
|
public function getActive(): Collection
|
|
{
|
|
return $this->user->recurrences()->with(['TransactionCurrency', 'TransactionType', 'RecurrenceRepetitions', 'RecurrenceTransactions'])->where(
|
|
'active', 1
|
|
)->get();
|
|
}
|
|
|
|
/**
|
|
* Get the notes.
|
|
*
|
|
* @param Recurrence $recurrence
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getNoteText(Recurrence $recurrence): string
|
|
{
|
|
/** @var Note $note */
|
|
$note = $recurrence->notes()->first();
|
|
if (null !== $note) {
|
|
return (string)$note->text;
|
|
}
|
|
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* Generate events in the date range.
|
|
*
|
|
* @param RecurrenceRepetition $repetition
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
*
|
|
* @throws FireflyException
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getOccurrencesInRange(RecurrenceRepetition $repetition, Carbon $start, Carbon $end): array
|
|
{
|
|
$return = [];
|
|
$mutator = clone $start;
|
|
$mutator->startOfDay();
|
|
$skipMod = $repetition->repetition_skip + 1;
|
|
$attempts = 0;
|
|
switch ($repetition->repetition_type) {
|
|
default:
|
|
throw new FireflyException(
|
|
sprintf('Cannot calculate occurrences for recurring transaction repetition type "%s"', $repetition->repetition_type)
|
|
);
|
|
case 'daily':
|
|
while ($mutator <= $end) {
|
|
if ($attempts % $skipMod === 0) {
|
|
$return[] = clone $mutator;
|
|
}
|
|
$mutator->addDay();
|
|
$attempts++;
|
|
}
|
|
break;
|
|
case 'weekly':
|
|
// monday = 1
|
|
// sunday = 7
|
|
$mutator->addDay(); // always assume today has passed.
|
|
$dayOfWeek = (int)$repetition->repetition_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 ($mutator <= $end) {
|
|
if ($attempts % $skipMod === 0) {
|
|
$return[] = clone $mutator;
|
|
}
|
|
$attempts++;
|
|
$mutator->addWeek();
|
|
}
|
|
break;
|
|
case 'monthly':
|
|
$dayOfMonth = (int)$repetition->repetition_moment;
|
|
if ($mutator->day > $dayOfMonth) {
|
|
// day has passed already, add a month.
|
|
$mutator->addMonth();
|
|
}
|
|
|
|
while ($mutator < $end) {
|
|
$domCorrected = min($dayOfMonth, $mutator->daysInMonth);
|
|
$mutator->day = $domCorrected;
|
|
if ($attempts % $skipMod === 0) {
|
|
$return[] = clone $mutator;
|
|
}
|
|
$attempts++;
|
|
$mutator->endOfMonth()->addDay();
|
|
}
|
|
break;
|
|
case 'ndom':
|
|
$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(',', $repetition->repetition_moment);
|
|
while ($mutator <= $end) {
|
|
$string = sprintf('%s %s of %s %s', $counters[$parts[0]], $daysOfWeek[$parts[1]], $mutator->format('F'), $mutator->format('Y'));
|
|
$newCarbon = new Carbon($string);
|
|
$return[] = clone $newCarbon;
|
|
$mutator->endOfMonth()->addDay();
|
|
}
|
|
break;
|
|
case 'yearly':
|
|
$date = new Carbon($repetition->repetition_moment);
|
|
$date->year = $mutator->year;
|
|
if ($mutator > $date) {
|
|
$date->addYear();
|
|
|
|
}
|
|
|
|
// is $date between $start and $end?
|
|
$obj = clone $date;
|
|
$count = 0;
|
|
while ($obj <= $end && $obj >= $mutator && $count < 10) {
|
|
|
|
$return[] = clone $obj;
|
|
$obj->addYears(1);
|
|
$count++;
|
|
}
|
|
break;
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* Calculate the next X iterations starting on the date given in $date.
|
|
*
|
|
* @param RecurrenceRepetition $repetition
|
|
* @param Carbon $date
|
|
* @param int $count
|
|
*
|
|
* @return array
|
|
* @throws FireflyException
|
|
*/
|
|
public function getXOccurrences(RecurrenceRepetition $repetition, Carbon $date, int $count): array
|
|
{
|
|
$return = [];
|
|
$mutator = clone $date;
|
|
$skipMod = $repetition->repetition_skip + 1;
|
|
$total = 0;
|
|
$attempts = 0;
|
|
switch ($repetition->repetition_type) {
|
|
default:
|
|
throw new FireflyException(
|
|
sprintf('Cannot calculate occurrences for recurring transaction repetition type "%s"', $repetition->repetition_type)
|
|
);
|
|
case 'daily':
|
|
while ($total < $count) {
|
|
$mutator->addDay();
|
|
if ($attempts % $skipMod === 0) {
|
|
$return[] = clone $mutator;
|
|
$total++;
|
|
}
|
|
$attempts++;
|
|
}
|
|
break;
|
|
case 'weekly':
|
|
// monday = 1
|
|
// sunday = 7
|
|
$mutator->addDay(); // always assume today has passed.
|
|
$dayOfWeek = (int)$repetition->repetition_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 ($attempts % $skipMod === 0) {
|
|
$return[] = clone $mutator;
|
|
$total++;
|
|
}
|
|
$attempts++;
|
|
$mutator->addWeek();
|
|
}
|
|
break;
|
|
case 'monthly':
|
|
$mutator->addDay(); // always assume today has passed.
|
|
$dayOfMonth = (int)$repetition->repetition_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 ($attempts % $skipMod === 0) {
|
|
$return[] = clone $mutator;
|
|
$total++;
|
|
}
|
|
$attempts++;
|
|
$mutator->endOfMonth()->addDay();
|
|
}
|
|
break;
|
|
case 'ndom':
|
|
$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(',', $repetition->repetition_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 ($attempts % $skipMod === 0) {
|
|
$return[] = clone $newCarbon;
|
|
$total++;
|
|
}
|
|
$attempts++;
|
|
$mutator->endOfMonth()->addDay();
|
|
}
|
|
break;
|
|
case 'yearly':
|
|
$date = new Carbon($repetition->repetition_moment);
|
|
$date->year = $mutator->year;
|
|
if ($mutator > $date) {
|
|
$date->addYear();
|
|
}
|
|
$obj = clone $date;
|
|
while ($total < $count) {
|
|
if ($attempts % $skipMod === 0) {
|
|
$return[] = clone $obj;
|
|
$total++;
|
|
}
|
|
$obj->addYears(1);
|
|
$attempts++;
|
|
}
|
|
break;
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* Parse the repetition in a string that is user readable.
|
|
*
|
|
* @param RecurrenceRepetition $repetition
|
|
*
|
|
* @return string
|
|
* @throws FireflyException
|
|
*/
|
|
public function repetitionDescription(RecurrenceRepetition $repetition): string
|
|
{
|
|
/** @var Preference $pref */
|
|
$pref = app('preferences')->getForUser($this->user, 'language', config('firefly.default_language', 'en_US'));
|
|
$language = $pref->data;
|
|
switch ($repetition->repetition_type) {
|
|
default:
|
|
throw new FireflyException(sprintf('Cannot translate recurring transaction repetition type "%s"', $repetition->repetition_type));
|
|
break;
|
|
case 'daily':
|
|
return trans('firefly.recurring_daily', [], $language);
|
|
break;
|
|
case 'weekly':
|
|
$dayOfWeek = trans(sprintf('config.dow_%s', $repetition->repetition_moment), [], $language);
|
|
|
|
return trans('firefly.recurring_weekly', ['weekday' => $dayOfWeek], $language);
|
|
break;
|
|
case 'monthly':
|
|
// format a date:
|
|
return trans('firefly.recurring_monthly', ['dayOfMonth' => $repetition->repetition_moment], $language);
|
|
break;
|
|
case 'ndom':
|
|
$parts = explode(',', $repetition->repetition_moment);
|
|
// first part is number of week, second is weekday.
|
|
$dayOfWeek = trans(sprintf('config.dow_%s', $parts[1]), [], $language);
|
|
|
|
return trans('firefly.recurring_ndom', ['weekday' => $dayOfWeek, 'dayOfMonth' => $parts[0]], $language);
|
|
break;
|
|
case 'yearly':
|
|
//
|
|
$today = new Carbon;
|
|
$today->endOfYear();
|
|
$repDate = Carbon::createFromFormat('Y-m-d', $repetition->repetition_moment);
|
|
$diffInYears = $today->diffInYears($repDate);
|
|
$repDate->addYears($diffInYears); // technically not necessary.
|
|
$string = $repDate->formatLocalized(trans('config.month_and_day_no_year'));
|
|
|
|
return trans('firefly.recurring_yearly', ['date' => $string], $language);
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Set user for in repository.
|
|
*
|
|
* @param User $user
|
|
*/
|
|
public function setUser(User $user): void
|
|
{
|
|
$this->user = $user;
|
|
}
|
|
|
|
/**
|
|
* @param array $data
|
|
*
|
|
* @throws FireflyException
|
|
* @return Recurrence
|
|
*/
|
|
public function store(array $data): Recurrence
|
|
{
|
|
$factory = new RecurrenceFactory;
|
|
$factory->setUser($this->user);
|
|
|
|
return $factory->create($data);
|
|
}
|
|
} |