gh-mirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-12-18 09:11:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: reformat code.

Browse Source
This commit is contained in:
James Cole
2023-06-21 12:34:58 +02:00
parent 8d87abde64
commit 3dcb35710b
799 changed files with 23319 additions and 22173 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
app/Handlers/Events/APIEventHandler.php
View File

@@ -39,7 +39,7 @@ class APIEventHandler
/**
* Respond to the creation of an access token.
*
* @param AccessTokenCreated $event
* @param AccessTokenCreated $event
*
* @throws FireflyException
*/

6
app/Handlers/Events/AdminEventHandler.php
View File

@@ -41,7 +41,7 @@ use Illuminate\Support\Facades\Notification;
class AdminEventHandler
{
/**
* @param InvitationCreated $event
* @param InvitationCreated $event
* @return void
*/
public function sendInvitationNotification(InvitationCreated $event): void
@@ -78,7 +78,7 @@ class AdminEventHandler
/**
* Send new version message to admin.
*
* @param NewVersionAvailable $event
* @param NewVersionAvailable $event
* @return void
*/
public function sendNewVersion(NewVersionAvailable $event): void
@@ -115,7 +115,7 @@ class AdminEventHandler
/**
* Sends a test message to an administrator.
*
* @param AdminRequestedTestMessage $event
* @param AdminRequestedTestMessage $event
*
* @return void
*/

2
app/Handlers/Events/AutomationHandler.php
View File

@@ -41,7 +41,7 @@ class AutomationHandler
/**
* Respond to the creation of X journals.
*
* @param RequestedReportOnJournals $event
* @param RequestedReportOnJournals $event
* @throws FireflyException
*/
public function reportJournals(RequestedReportOnJournals $event): void

2
app/Handlers/Events/BillEventHandler.php
View File

@@ -37,7 +37,7 @@ use Illuminate\Support\Facades\Notification;
class BillEventHandler
{
/**
* @param WarnUserAboutBill $event
* @param WarnUserAboutBill $event
* @return void
*/
public function warnAboutBill(WarnUserAboutBill $event): void

2
app/Handlers/Events/DestroyedGroupEventHandler.php
View File

@@ -36,7 +36,7 @@ use Illuminate\Support\Facades\Log;
class DestroyedGroupEventHandler
{
/**
* @param DestroyedTransactionGroup $destroyedGroupEvent
* @param DestroyedTransactionGroup $destroyedGroupEvent
*/
public function triggerWebhooks(DestroyedTransactionGroup $destroyedGroupEvent): void
{

226
app/Handlers/Events/Model/BudgetLimitHandler.php
View File

@@ -43,7 +43,7 @@ use Spatie\Period\Precision;
class BudgetLimitHandler
{
/**
* @param Created $event
* @param Created $event
* @return void
*/
public function created(Created $event): void
@@ -53,117 +53,7 @@ class BudgetLimitHandler
}
/**
* @param Deleted $event
* @return void
*/
public function deleted(Deleted $event): void
{
Log::debug(sprintf('BudgetLimitHandler::deleted(#%s)', $event->budgetLimit->id));
$budgetLimit = $event->budgetLimit;
$budgetLimit->id = null;
$this->updateAvailableBudget($event->budgetLimit);
}
/**
* @param Updated $event
* @return void
*/
public function updated(Updated $event): void
{
Log::debug(sprintf('BudgetLimitHandler::updated(#%s)', $event->budgetLimit->id));
$this->updateAvailableBudget($event->budgetLimit);
}
/**
* @param AvailableBudget $availableBudget
* @return void
*/
private function calculateAmount(AvailableBudget $availableBudget): void
{
$repository = app(BudgetLimitRepositoryInterface::class);
$repository->setUser($availableBudget->user);
$newAmount = '0';
$abPeriod = Period::make($availableBudget->start_date, $availableBudget->end_date, Precision::DAY());
Log::debug(
sprintf(
'Now at AB #%d, ("%s" to "%s")',
$availableBudget->id,
$availableBudget->start_date->format('Y-m-d'),
$availableBudget->end_date->format('Y-m-d')
)
);
// have to recalc everything just in case.
$set = $repository->getAllBudgetLimitsByCurrency($availableBudget->transactionCurrency, $availableBudget->start_date, $availableBudget->end_date);
Log::debug(sprintf('Found %d interesting budget limit(s).', $set->count()));
/** @var BudgetLimit $budgetLimit */
foreach ($set as $budgetLimit) {
Log::debug(
sprintf(
'Found interesting budget limit #%d ("%s" to "%s")',
$budgetLimit->id,
$budgetLimit->start_date->format('Y-m-d'),
$budgetLimit->end_date->format('Y-m-d')
)
);
// overlap in days:
$limitPeriod = Period::make(
$budgetLimit->start_date,
$budgetLimit->end_date,
precision: Precision::DAY(),
boundaries: Boundaries::EXCLUDE_NONE()
);
// if both equal eachother, amount from this BL must be added to the AB
if ($limitPeriod->equals($abPeriod)) {
$newAmount = bcadd($newAmount, $budgetLimit->amount);
}
// if budget limit period inside AB period, can be added in full.
if (!$limitPeriod->equals($abPeriod) && $abPeriod->contains($limitPeriod)) {
$newAmount = bcadd($newAmount, $budgetLimit->amount);
}
if (!$limitPeriod->equals($abPeriod) && $abPeriod->overlapsWith($limitPeriod)) {
$overlap = $abPeriod->overlap($limitPeriod);
if (null !== $overlap) {
$length = $overlap->length();
$daily = bcmul($this->getDailyAmount($budgetLimit), (string)$length);
$newAmount = bcadd($newAmount, $daily);
}
}
}
if (0 === bccomp('0', $newAmount)) {
Log::debug('New amount is zero, deleting AB.');
$availableBudget->delete();
return;
}
Log::debug(sprintf('Concluded new amount for this AB must be %s', $newAmount));
$availableBudget->amount = $newAmount;
$availableBudget->save();
}
/**
* @param BudgetLimit $budgetLimit
* @return string
*/
private function getDailyAmount(BudgetLimit $budgetLimit): string
{
if (0 === (int)$budgetLimit->id) {
return '0';
}
$limitPeriod = Period::make(
$budgetLimit->start_date,
$budgetLimit->end_date,
precision: Precision::DAY(),
boundaries: Boundaries::EXCLUDE_NONE()
);
$days = $limitPeriod->length();
$amount = bcdiv((string)$budgetLimit->amount, (string)$days, 12);
Log::debug(
sprintf('Total amount for budget limit #%d is %s. Nr. of days is %d. Amount per day is %s', $budgetLimit->id, $budgetLimit->amount, $days, $amount)
);
return $amount;
}
/**
* @param BudgetLimit $budgetLimit
* @param BudgetLimit $budgetLimit
* @return void
*/
private function updateAvailableBudget(BudgetLimit $budgetLimit): void
@@ -175,7 +65,7 @@ class BudgetLimitHandler
// all have to be created or updated.
try {
$viewRange = app('preferences')->get('viewRange', '1M')->data;
} catch (ContainerExceptionInterface|NotFoundExceptionInterface $e) {
} catch (ContainerExceptionInterface | NotFoundExceptionInterface $e) {
$viewRange = '1M';
}
$start = app('navigation')->startOfPeriod($budgetLimit->start_date, $viewRange);
@@ -248,4 +138,114 @@ class BudgetLimitHandler
}
}
/**
* @param AvailableBudget $availableBudget
* @return void
*/
private function calculateAmount(AvailableBudget $availableBudget): void
{
$repository = app(BudgetLimitRepositoryInterface::class);
$repository->setUser($availableBudget->user);
$newAmount = '0';
$abPeriod = Period::make($availableBudget->start_date, $availableBudget->end_date, Precision::DAY());
Log::debug(
sprintf(
'Now at AB #%d, ("%s" to "%s")',
$availableBudget->id,
$availableBudget->start_date->format('Y-m-d'),
$availableBudget->end_date->format('Y-m-d')
)
);
// have to recalc everything just in case.
$set = $repository->getAllBudgetLimitsByCurrency($availableBudget->transactionCurrency, $availableBudget->start_date, $availableBudget->end_date);
Log::debug(sprintf('Found %d interesting budget limit(s).', $set->count()));
/** @var BudgetLimit $budgetLimit */
foreach ($set as $budgetLimit) {
Log::debug(
sprintf(
'Found interesting budget limit #%d ("%s" to "%s")',
$budgetLimit->id,
$budgetLimit->start_date->format('Y-m-d'),
$budgetLimit->end_date->format('Y-m-d')
)
);
// overlap in days:
$limitPeriod = Period::make(
$budgetLimit->start_date,
$budgetLimit->end_date,
precision : Precision::DAY(),
boundaries: Boundaries::EXCLUDE_NONE()
);
// if both equal eachother, amount from this BL must be added to the AB
if ($limitPeriod->equals($abPeriod)) {
$newAmount = bcadd($newAmount, $budgetLimit->amount);
}
// if budget limit period inside AB period, can be added in full.
if (!$limitPeriod->equals($abPeriod) && $abPeriod->contains($limitPeriod)) {
$newAmount = bcadd($newAmount, $budgetLimit->amount);
}
if (!$limitPeriod->equals($abPeriod) && $abPeriod->overlapsWith($limitPeriod)) {
$overlap = $abPeriod->overlap($limitPeriod);
if (null !== $overlap) {
$length = $overlap->length();
$daily = bcmul($this->getDailyAmount($budgetLimit), (string)$length);
$newAmount = bcadd($newAmount, $daily);
}
}
}
if (0 === bccomp('0', $newAmount)) {
Log::debug('New amount is zero, deleting AB.');
$availableBudget->delete();
return;
}
Log::debug(sprintf('Concluded new amount for this AB must be %s', $newAmount));
$availableBudget->amount = $newAmount;
$availableBudget->save();
}
/**
* @param BudgetLimit $budgetLimit
* @return string
*/
private function getDailyAmount(BudgetLimit $budgetLimit): string
{
if (0 === (int)$budgetLimit->id) {
return '0';
}
$limitPeriod = Period::make(
$budgetLimit->start_date,
$budgetLimit->end_date,
precision : Precision::DAY(),
boundaries: Boundaries::EXCLUDE_NONE()
);
$days = $limitPeriod->length();
$amount = bcdiv((string)$budgetLimit->amount, (string)$days, 12);
Log::debug(
sprintf('Total amount for budget limit #%d is %s. Nr. of days is %d. Amount per day is %s', $budgetLimit->id, $budgetLimit->amount, $days, $amount)
);
return $amount;
}
/**
* @param Deleted $event
* @return void
*/
public function deleted(Deleted $event): void
{
Log::debug(sprintf('BudgetLimitHandler::deleted(#%s)', $event->budgetLimit->id));
$budgetLimit = $event->budgetLimit;
$budgetLimit->id = null;
$this->updateAvailableBudget($event->budgetLimit);
}
/**
* @param Updated $event
* @return void
*/
public function updated(Updated $event): void
{
Log::debug(sprintf('BudgetLimitHandler::updated(#%s)', $event->budgetLimit->id));
$this->updateAvailableBudget($event->budgetLimit);
}
}

2
app/Handlers/Events/PiggyBankEventHandler.php
View File

@@ -34,7 +34,7 @@ use Illuminate\Support\Facades\Log;
class PiggyBankEventHandler
{
/**
* @param ChangedPiggyBankAmount $event
* @param ChangedPiggyBankAmount $event
* @return void
*/
public function changePiggyAmount(ChangedPiggyBankAmount $event): void

2
app/Handlers/Events/StoredAccountEventHandler.php
View File

@@ -33,7 +33,7 @@ use FireflyIII\Services\Internal\Support\CreditRecalculateService;
class StoredAccountEventHandler
{
/**
* @param StoredAccount $event
* @param StoredAccount $event
*/
public function recalculateCredit(StoredAccount $event): void
{

6
app/Handlers/Events/StoredGroupEventHandler.php
View File

@@ -42,7 +42,7 @@ class StoredGroupEventHandler
/**
* This method grabs all the users rules and processes them.
*
* @param StoredTransactionGroup $storedGroupEvent
* @param StoredTransactionGroup $storedGroupEvent
*/
public function processRules(StoredTransactionGroup $storedGroupEvent): void
{
@@ -79,7 +79,7 @@ class StoredGroupEventHandler
}
/**
* @param StoredTransactionGroup $event
* @param StoredTransactionGroup $event
*/
public function recalculateCredit(StoredTransactionGroup $event): void
{
@@ -93,7 +93,7 @@ class StoredGroupEventHandler
/**
* This method processes all webhooks that respond to the "stored transaction group" trigger (100)
*
* @param StoredTransactionGroup $storedGroupEvent
* @param StoredTransactionGroup $storedGroupEvent
*/
public function triggerWebhooks(StoredTransactionGroup $storedGroupEvent): void
{

2
app/Handlers/Events/UpdatedAccountEventHandler.php
View File

@@ -33,7 +33,7 @@ use FireflyIII\Services\Internal\Support\CreditRecalculateService;
class UpdatedAccountEventHandler
{
/**
* @param UpdatedAccount $event
* @param UpdatedAccount $event
*/
public function recalculateCredit(UpdatedAccount $event): void
{

8
app/Handlers/Events/UpdatedGroupEventHandler.php
View File

@@ -45,7 +45,7 @@ class UpdatedGroupEventHandler
/**
* This method will check all the rules when a journal is updated.
*
* @param UpdatedTransactionGroup $updatedGroupEvent
* @param UpdatedTransactionGroup $updatedGroupEvent
*/
public function processRules(UpdatedTransactionGroup $updatedGroupEvent): void
{
@@ -79,7 +79,7 @@ class UpdatedGroupEventHandler
}
/**
* @param UpdatedTransactionGroup $event
* @param UpdatedTransactionGroup $event
*/
public function recalculateCredit(UpdatedTransactionGroup $event): void
{
@@ -91,7 +91,7 @@ class UpdatedGroupEventHandler
}
/**
* @param UpdatedTransactionGroup $updatedGroupEvent
* @param UpdatedTransactionGroup $updatedGroupEvent
*/
public function triggerWebhooks(UpdatedTransactionGroup $updatedGroupEvent): void
{
@@ -116,7 +116,7 @@ class UpdatedGroupEventHandler
/**
* This method will make sure all source / destination accounts are the same.
*
* @param UpdatedTransactionGroup $updatedGroupEvent
* @param UpdatedTransactionGroup $updatedGroupEvent
*/
public function unifyAccounts(UpdatedTransactionGroup $updatedGroupEvent): void
{

27
app/Handlers/Events/UserEventHandler.php
View File

@@ -63,7 +63,7 @@ class UserEventHandler
/**
* This method will bestow upon a user the "owner" role if he is the first user in the system.
*
* @param RegisteredUser $event
* @param RegisteredUser $event
*/
public function attachUserRole(RegisteredUser $event): void
{
@@ -80,7 +80,7 @@ class UserEventHandler
/**
* Fires to see if a user is admin.
*
* @param Login $event
* @param Login $event
*/
public function checkSingleUserIsAdmin(Login $event): void
{
@@ -108,7 +108,7 @@ class UserEventHandler
}
/**
* @param RegisteredUser $event
* @param RegisteredUser $event
*/
public function createExchangeRates(RegisteredUser $event): void
{
@@ -117,7 +117,7 @@ class UserEventHandler
}
/**
* @param RegisteredUser $event
* @param RegisteredUser $event
*
* @throws FireflyException
*/
@@ -162,7 +162,7 @@ class UserEventHandler
/**
* Set the demo user back to English.
*
* @param Login $event
* @param Login $event
*
* @throws FireflyException
*/
@@ -182,7 +182,7 @@ class UserEventHandler
}
/**
* @param DetectedNewIPAddress $event
* @param DetectedNewIPAddress $event
*
* @throws FireflyException
*/
@@ -224,7 +224,7 @@ class UserEventHandler
}
/**
* @param RegisteredUser $event
* @param RegisteredUser $event
*/
public function sendAdminRegistrationNotification(RegisteredUser $event): void
{
@@ -259,7 +259,7 @@ class UserEventHandler
* Send email to confirm email change. Will not be made into a notification, because
* this requires some custom fields from the user and not just the "user" object.
*
* @param UserChangedEmail $event
* @param UserChangedEmail $event
*
* @throws FireflyException
*/
@@ -283,7 +283,7 @@ class UserEventHandler
* Send email to be able to undo email change. Will not be made into a notification, because
* this requires some custom fields from the user and not just the "user" object.
*
* @param UserChangedEmail $event
* @param UserChangedEmail $event
*
* @throws FireflyException
*/
@@ -305,7 +305,8 @@ class UserEventHandler
/**
* Send a new password to the user.
* @param RequestedNewPassword $event
*
* @param RequestedNewPassword $event
*/
public function sendNewPassword(RequestedNewPassword $event): void
{
@@ -327,7 +328,7 @@ class UserEventHandler
}
/**
* @param InvitationCreated $event
* @param InvitationCreated $event
* @return void
* @throws FireflyException
*/
@@ -348,7 +349,7 @@ class UserEventHandler
* This method will send the user a registration mail, welcoming him or her to Firefly III.
* This message is only sent when the configuration of Firefly III says so.
*
* @param RegisteredUser $event
* @param RegisteredUser $event
*
*/
public function sendRegistrationMail(RegisteredUser $event): void
@@ -374,7 +375,7 @@ class UserEventHandler
}
/**
* @param ActuallyLoggedIn $event
* @param ActuallyLoggedIn $event
* @throws FireflyException
*/
public function storeUserIPAddress(ActuallyLoggedIn $event): void

4
app/Handlers/Events/VersionCheckEventHandler.php
View File

@@ -42,7 +42,7 @@ class VersionCheckEventHandler
/**
* Checks with GitHub to see if there is a new version.
*
* @param RequestedVersionCheckStatus $event
* @param RequestedVersionCheckStatus $event
*
* @throws FireflyException
* @throws ContainerExceptionInterface
@@ -91,7 +91,7 @@ class VersionCheckEventHandler
}
/**
* @param RequestedVersionCheckStatus $event
* @param RequestedVersionCheckStatus $event
*
* @throws FireflyException
* @throws ContainerExceptionInterface