kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-09-23 14:26:58 +00:00
Code Issues 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

131
app/Support/Chart/Budget/FrontpageChartGenerator.php
View File

@@ -79,61 +79,34 @@ class FrontpageChartGenerator
}
/**
* @param Carbon $end
*/
public function setEnd(Carbon $end): void
{
$this->end = $end;
}
/**
* @param Carbon $start
*/
public function setStart(Carbon $start): void
{
$this->start = $start;
}
/**
* A basic setter for the user. Also updates the repositories with the right user.
* For each budget, gets all budget limits for the current time range.
* When no limits are present, the time range is used to collect information on money spent.
* If limits are present, each limit is processed individually.
*
* @param User $user
*/
public function setUser(User $user): void
{
$this->budgetRepository->setUser($user);
$this->blRepository->setUser($user);
$this->opsRepository->setUser($user);
$locale = app('steam')->getLocale();
$this->monthAndDayFormat = (string)trans('config.month_and_day_js', [], $locale);
}
/**
* If a budget has budget limit, each limit is processed individually.
*
* @param array $data
* @param Budget $budget
* @param Collection $limits
* @param array $data
* @param Budget $budget
*
* @return array
*/
private function budgetLimits(array $data, Budget $budget, Collection $limits): array
private function processBudget(array $data, Budget $budget): array
{
/** @var BudgetLimit $limit */
foreach ($limits as $limit) {
$data = $this->processLimit($data, $budget, $limit);
// get all limits:
$limits = $this->blRepository->getBudgetLimits($budget, $this->start, $this->end);
// if no limits
if (0 === $limits->count()) {
return $this->noBudgetLimits($data, $budget);
}
return $data;
return $this->budgetLimits($data, $budget, $limits);
}
/**
* When no limits are present, the expenses of the whole period are collected and grouped.
* This is grouped per currency. Because there is no limit set, "left to spend" and "overspent" are empty.
*
* @param array $data
* @param Budget $budget
* @param array $data
* @param Budget $budget
*
* @return array
*/
@@ -152,34 +125,31 @@ class FrontpageChartGenerator
}
/**
* For each budget, gets all budget limits for the current time range.
* When no limits are present, the time range is used to collect information on money spent.
* If limits are present, each limit is processed individually.
* If a budget has budget limit, each limit is processed individually.
*
* @param array $data
* @param Budget $budget
* @param array $data
* @param Budget $budget
* @param Collection $limits
*
* @return array
*/
private function processBudget(array $data, Budget $budget): array
private function budgetLimits(array $data, Budget $budget, Collection $limits): array
{
// get all limits:
$limits = $this->blRepository->getBudgetLimits($budget, $this->start, $this->end);
// if no limits
if (0 === $limits->count()) {
return $this->noBudgetLimits($data, $budget);
/** @var BudgetLimit $limit */
foreach ($limits as $limit) {
$data = $this->processLimit($data, $budget, $limit);
}
return $this->budgetLimits($data, $budget, $limits);
return $data;
}
/**
* For each limit, the expenses from the time range of the limit are collected. Each row from the result is processed individually.
* For each limit, the expenses from the time range of the limit are collected. Each row from the result is
* processed individually.
*
* @param array $data
* @param Budget $budget
* @param BudgetLimit $limit
* @param array $data
* @param Budget $budget
* @param BudgetLimit $limit
*
* @return array
*/
@@ -200,13 +170,13 @@ class FrontpageChartGenerator
/**
* Each row of expenses from a budget limit is in another currency (note $entry['currency_name']).
*
* Each one is added to the $data array. If the limit's date range is different from the global $start and $end dates,
* for example when a limit only partially falls into this month, the title is expanded to clarify.
* Each one is added to the $data array. If the limit's date range is different from the global $start and $end
* dates, for example when a limit only partially falls into this month, the title is expanded to clarify.
*
* @param array $data
* @param Budget $budget
* @param BudgetLimit $limit
* @param array $entry
* @param array $data
* @param Budget $budget
* @param BudgetLimit $limit
* @param array $entry
*
* @return array
*/
@@ -230,4 +200,35 @@ class FrontpageChartGenerator
return $data;
}
/**
* @param Carbon $end
*/
public function setEnd(Carbon $end): void
{
$this->end = $end;
}
/**
* @param Carbon $start
*/
public function setStart(Carbon $start): void
{
$this->start = $start;
}
/**
* A basic setter for the user. Also updates the repositories with the right user.
*
* @param User $user
*/
public function setUser(User $user): void
{
$this->budgetRepository->setUser($user);
$this->blRepository->setUser($user);
$this->opsRepository->setUser($user);
$locale = app('steam')->getLocale();
$this->monthAndDayFormat = (string)trans('config.month_and_day_js', [], $locale);
}
}

48
app/Support/Chart/Category/FrontpageChartGenerator.php
View File

@@ -52,8 +52,8 @@ class FrontpageChartGenerator
/**
* FrontpageChartGenerator constructor.
*
* @param Carbon $start
* @param Carbon $end
* @param Carbon $start
* @param Carbon $end
*/
public function __construct(Carbon $start, Carbon $end)
{
@@ -99,24 +99,8 @@ class FrontpageChartGenerator
}
/**
* @param array $currency
*/
private function addCurrency(array $currency): void
{
$currencyId = (int)$currency['currency_id'];
$this->currencies[$currencyId] = $this->currencies[$currencyId] ?? [
'currency_id' => $currencyId,
'currency_name' => $currency['currency_name'],
'currency_symbol' => $currency['currency_symbol'],
'currency_code' => $currency['currency_code'],
'currency_decimal_places' => $currency['currency_decimal_places'],
];
}
/**
* @param Category $category
* @param Collection $accounts
* @param Category $category
* @param Collection $accounts
*
* @return array
*/
@@ -138,7 +122,23 @@ class FrontpageChartGenerator
}
/**
* @param Collection $accounts
* @param array $currency
*/
private function addCurrency(array $currency): void
{
$currencyId = (int)$currency['currency_id'];
$this->currencies[$currencyId] = $this->currencies[$currencyId] ?? [
'currency_id' => $currencyId,
'currency_name' => $currency['currency_name'],
'currency_symbol' => $currency['currency_symbol'],
'currency_code' => $currency['currency_code'],
'currency_decimal_places' => $currency['currency_decimal_places'],
];
}
/**
* @param Collection $accounts
*
* @return array
*/
@@ -160,7 +160,7 @@ class FrontpageChartGenerator
}
/**
* @param array $data
* @param array $data
*
* @return array
*/
@@ -185,8 +185,8 @@ class FrontpageChartGenerator
}
/**
* @param array $currencyData
* @param array $monetaryData
* @param array $currencyData
* @param array $monetaryData
*
* @return array
*/

12
app/Support/Chart/Category/WholePeriodChartGenerator.php
View File

@@ -36,9 +36,9 @@ use Illuminate\Support\Collection;
class WholePeriodChartGenerator
{
/**
* @param Category $category
* @param Carbon $start
* @param Carbon $end
* @param Category $category
* @param Carbon $start
* @param Carbon $end
*
* @return array
*/
@@ -117,8 +117,8 @@ class WholePeriodChartGenerator
/**
* TODO this method is duplicated
*
* @param Carbon $start
* @param Carbon $end
* @param Carbon $start
* @param Carbon $end
*
* @return string
*/
@@ -143,7 +143,7 @@ class WholePeriodChartGenerator
* Loop array of spent/earned info, and extract which currencies are present.
* Key is the currency ID.
*
* @param array $array
* @param array $array
*
* @return array
*/