mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-10-31 10:47:00 +00:00
254 lines
9.1 KiB
PHP
254 lines
9.1 KiB
PHP
<?php
|
|
|
|
/**
|
|
* IndexController.php
|
|
* Copyright (c) 2020 james@firefly-iii.org
|
|
*
|
|
* This file is part of Firefly III (https://github.com/firefly-iii).
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program 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 Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace FireflyIII\Http\Controllers\Bill;
|
|
|
|
|
|
use Carbon\Carbon;
|
|
use FireflyIII\Http\Controllers\Controller;
|
|
use FireflyIII\Models\Bill;
|
|
use FireflyIII\Models\TransactionCurrency;
|
|
use FireflyIII\Repositories\Bill\BillRepositoryInterface;
|
|
use FireflyIII\Repositories\ObjectGroup\OrganisesObjectGroups;
|
|
use FireflyIII\Transformers\BillTransformer;
|
|
use Illuminate\Http\JsonResponse;
|
|
use Illuminate\Http\Request;
|
|
use Log;
|
|
use Symfony\Component\HttpFoundation\ParameterBag;
|
|
|
|
/**
|
|
* Class IndexController
|
|
*/
|
|
class IndexController extends Controller
|
|
{
|
|
use OrganisesObjectGroups;
|
|
private BillRepositoryInterface $repository;
|
|
|
|
/**
|
|
* BillController constructor.
|
|
*
|
|
* @codeCoverageIgnore
|
|
*/
|
|
public function __construct()
|
|
{
|
|
parent::__construct();
|
|
|
|
$this->middleware(
|
|
function ($request, $next) {
|
|
app('view')->share('title', (string) trans('firefly.bills'));
|
|
app('view')->share('mainTitleIcon', 'fa-calendar-o');
|
|
$this->repository = app(BillRepositoryInterface::class);
|
|
|
|
return $next($request);
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Show all bills.
|
|
*/
|
|
public function index()
|
|
{
|
|
$this->cleanupObjectGroups();
|
|
$this->repository->correctOrder();
|
|
|
|
|
|
$start = session('start');
|
|
$end = session('end');
|
|
$collection = $this->repository->getBills();
|
|
$total = $collection->count();
|
|
|
|
$defaultCurrency = app('amount')->getDefaultCurrency();
|
|
$parameters = new ParameterBag;
|
|
$parameters->set('start', $start);
|
|
$parameters->set('end', $end);
|
|
|
|
/** @var BillTransformer $transformer */
|
|
$transformer = app(BillTransformer::class);
|
|
$transformer->setParameters($parameters);
|
|
|
|
// loop all bills, convert to array and add rules and stuff.
|
|
$rules = $this->repository->getRulesForBills($collection);
|
|
|
|
// make bill groups:
|
|
$bills = [
|
|
0 => [ // the index is the order, not the ID.
|
|
'object_group_id' => 0,
|
|
'object_group_title' => (string) trans('firefly.default_group_title_name'),
|
|
'bills' => [],
|
|
],
|
|
];
|
|
|
|
|
|
/** @var Bill $bill */
|
|
foreach ($collection as $bill) {
|
|
$array = $transformer->transform($bill);
|
|
$groupOrder = (int) $array['object_group_order'];
|
|
// make group array if necessary:
|
|
$bills[$groupOrder] = $bills[$groupOrder] ?? [
|
|
'object_group_id' => $array['object_group_id'],
|
|
'object_group_title' => $array['object_group_title'],
|
|
'bills' => [],
|
|
];
|
|
|
|
// expected today? default:
|
|
$array['next_expected_match_diff'] = trans('firefly.not_expected_period');
|
|
$nextExpectedMatch = new Carbon($array['next_expected_match']);
|
|
if ($nextExpectedMatch->isToday()) {
|
|
$array['next_expected_match_diff'] = trans('firefly.today');
|
|
}
|
|
$current = $array['pay_dates'][0] ?? null;
|
|
if (null !== $current && !$nextExpectedMatch->isToday()) {
|
|
$currentExpectedMatch = Carbon::createFromFormat('!Y-m-d', $current);
|
|
$array['next_expected_match_diff'] = $currentExpectedMatch->diffForHumans(today(), Carbon::DIFF_RELATIVE_TO_NOW);
|
|
}
|
|
|
|
$currency = $bill->transactionCurrency ?? $defaultCurrency;
|
|
$array['currency_id'] = $currency->id;
|
|
$array['currency_name'] = $currency->name;
|
|
$array['currency_symbol'] = $currency->symbol;
|
|
$array['currency_code'] = $currency->code;
|
|
$array['currency_decimal_places'] = $currency->decimal_places;
|
|
$array['attachments'] = $this->repository->getAttachments($bill);
|
|
$array['rules'] = $rules[$bill['id']] ?? [];
|
|
$bills[$groupOrder]['bills'][] = $array;
|
|
}
|
|
|
|
// order by key
|
|
ksort($bills);
|
|
|
|
// summarise per currency / per group.
|
|
$sums = $this->getSums($bills);
|
|
|
|
return view('bills.index', compact('bills', 'sums', 'total'));
|
|
}
|
|
|
|
|
|
/**
|
|
* @param array $bills
|
|
*
|
|
* @return array
|
|
*/
|
|
private function getSums(array $bills): array
|
|
{
|
|
$sums = [];
|
|
$range = app('preferences')->get('viewRange', '1M')->data;
|
|
|
|
/** @var array $group */
|
|
foreach ($bills as $groupOrder => $group) {
|
|
/** @var array $bill */
|
|
foreach ($group['bills'] as $bill) {
|
|
if (false === $bill['active']) {
|
|
continue;
|
|
}
|
|
|
|
/** @var TransactionCurrency $currency */
|
|
$currencyId = $bill['currency_id'];
|
|
$sums[$groupOrder][$currencyId] = $sums[$groupOrder][$currencyId] ?? [
|
|
'currency_id' => $currencyId,
|
|
'currency_code' => $bill['currency_code'],
|
|
'currency_name' => $bill['currency_name'],
|
|
'currency_symbol' => $bill['currency_symbol'],
|
|
'currency_decimal_places' => $bill['currency_decimal_places'],
|
|
'avg' => '0',
|
|
'period' => $range,
|
|
'per_period' => '0',
|
|
];
|
|
// only fill in avg when bill is active.
|
|
if (count($bill['pay_dates']) > 0) {
|
|
$avg = bcdiv(bcadd((string) $bill['amount_min'], (string) $bill['amount_max']), '2');
|
|
$avg = bcmul($avg, (string) count($bill['pay_dates']));
|
|
$sums[$groupOrder][$currencyId]['avg'] = bcadd($sums[$groupOrder][$currencyId]['avg'], $avg);
|
|
}
|
|
// fill in per period regardless:
|
|
$sums[$groupOrder][$currencyId]['per_period'] = bcadd($sums[$groupOrder][$currencyId]['per_period'], $this->amountPerPeriod($bill, $range));
|
|
}
|
|
}
|
|
|
|
return $sums;
|
|
}
|
|
|
|
/**
|
|
* @param array $bill
|
|
* @param string $range
|
|
*
|
|
* @return string
|
|
*/
|
|
private function amountPerPeriod(array $bill, string $range): string
|
|
{
|
|
$avg = bcdiv(bcadd((string) $bill['amount_min'], (string) $bill['amount_max']), '2');
|
|
|
|
Log::debug(sprintf('Amount per period for bill #%d "%s"', $bill['id'], $bill['name']));
|
|
Log::debug(sprintf(sprintf('Average is %s', $avg)));
|
|
// calculate amount per year:
|
|
$multiplies = [
|
|
'yearly' => '1',
|
|
'half-year' => '2',
|
|
'quarterly' => '4',
|
|
'monthly' => '12',
|
|
'weekly' => '52.17',
|
|
];
|
|
$yearAmount = bcmul($avg, $multiplies[$bill['repeat_freq']]);
|
|
Log::debug(sprintf('Amount per year is %s (%s * %s)', $yearAmount, $avg, $multiplies[$bill['repeat_freq']]));
|
|
|
|
// per period:
|
|
$division = [
|
|
'1Y' => '1',
|
|
'6M' => '2',
|
|
'3M' => '4',
|
|
'1M' => '12',
|
|
'1W' => '52.16',
|
|
'1D' => '365.24',
|
|
];
|
|
$perPeriod = bcdiv($yearAmount, $division[$range]);
|
|
|
|
Log::debug(sprintf('Amount per %s is %s (%s / %s)', $range, $perPeriod, $yearAmount, $division[$range]));
|
|
|
|
return $perPeriod;
|
|
}
|
|
|
|
/**
|
|
* Set the order of a bill.
|
|
*
|
|
* @param Request $request
|
|
* @param Bill $bill
|
|
*
|
|
* @return JsonResponse
|
|
*/
|
|
public function setOrder(Request $request, Bill $bill): JsonResponse
|
|
{
|
|
$objectGroupTitle = (string)$request->get('objectGroupTitle');
|
|
$newOrder = (int) $request->get('order');
|
|
$this->repository->setOrder($bill, $newOrder);
|
|
if ('' !== $objectGroupTitle) {
|
|
$this->repository->setObjectGroup($bill, $objectGroupTitle);
|
|
}
|
|
if ('' === $objectGroupTitle) {
|
|
$this->repository->removeObjectGroup($bill);
|
|
}
|
|
|
|
return response()->json(['data' => 'OK']);
|
|
}
|
|
}
|