mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-01-06 22:23:48 -06:00
311 lines
11 KiB
PHP
311 lines
11 KiB
PHP
<?php
|
|
/**
|
|
* ReportHelper.php
|
|
* Copyright (C) 2016 thegrumpydictator@gmail.com
|
|
*
|
|
* This software may be modified and distributed under the terms of the
|
|
* Creative Commons Attribution-ShareAlike 4.0 International License.
|
|
*
|
|
* See the LICENSE file for details.
|
|
*/
|
|
|
|
declare(strict_types = 1);
|
|
|
|
namespace FireflyIII\Helpers\Report;
|
|
|
|
use Carbon\Carbon;
|
|
use DB;
|
|
use FireflyIII\Helpers\Collection\Bill as BillCollection;
|
|
use FireflyIII\Helpers\Collection\BillLine;
|
|
use FireflyIII\Helpers\Collection\Category as CategoryCollection;
|
|
use FireflyIII\Helpers\Collection\Expense;
|
|
use FireflyIII\Helpers\Collection\Income;
|
|
use FireflyIII\Helpers\FiscalHelperInterface;
|
|
use FireflyIII\Models\Bill;
|
|
use FireflyIII\Models\Budget;
|
|
use FireflyIII\Models\Category;
|
|
use FireflyIII\Models\Tag;
|
|
use FireflyIII\Models\TransactionJournal;
|
|
use FireflyIII\Repositories\Account\AccountTaskerInterface;
|
|
use FireflyIII\Repositories\Bill\BillRepositoryInterface;
|
|
use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
|
|
use FireflyIII\Repositories\Category\CategoryRepositoryInterface;
|
|
use FireflyIII\Repositories\Tag\TagRepositoryInterface;
|
|
use Illuminate\Database\Eloquent\Builder;
|
|
use Illuminate\Database\Query\JoinClause;
|
|
use Illuminate\Support\Collection;
|
|
use stdClass;
|
|
|
|
/**
|
|
* Class ReportHelper
|
|
*
|
|
* @package FireflyIII\Helpers\Report
|
|
*/
|
|
class ReportHelper implements ReportHelperInterface
|
|
{
|
|
|
|
/** @var BudgetRepositoryInterface */
|
|
protected $budgetRepository;
|
|
/** @var TagRepositoryInterface */
|
|
protected $tagRepository;
|
|
|
|
/**
|
|
* ReportHelper constructor.
|
|
*
|
|
*
|
|
* @param BudgetRepositoryInterface $budgetRepository
|
|
* @param TagRepositoryInterface $tagRepository
|
|
*/
|
|
public function __construct(BudgetRepositoryInterface $budgetRepository, TagRepositoryInterface $tagRepository)
|
|
{
|
|
$this->budgetRepository = $budgetRepository;
|
|
$this->tagRepository = $tagRepository;
|
|
}
|
|
|
|
/**
|
|
* This method generates a full report for the given period on all
|
|
* the users bills and their payments.
|
|
*
|
|
* Excludes bills which have not had a payment on the mentioned accounts.
|
|
*
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
* @param Collection $accounts
|
|
*
|
|
* @return BillCollection
|
|
*/
|
|
public function getBillReport(Carbon $start, Carbon $end, Collection $accounts): BillCollection
|
|
{
|
|
/** @var BillRepositoryInterface $repository */
|
|
$repository = app(BillRepositoryInterface::class);
|
|
$bills = $repository->getBillsForAccounts($accounts);
|
|
$journals = $repository->getAllJournalsInRange($bills, $start, $end);
|
|
$collection = new BillCollection;
|
|
|
|
/** @var Bill $bill */
|
|
foreach ($bills as $bill) {
|
|
$billLine = new BillLine;
|
|
$billLine->setBill($bill);
|
|
$billLine->setActive(intval($bill->active) === 1);
|
|
$billLine->setMin(strval($bill->amount_min));
|
|
$billLine->setMax(strval($bill->amount_max));
|
|
$billLine->setHit(false);
|
|
// is hit in period?
|
|
|
|
$entry = $journals->filter(
|
|
function (TransactionJournal $journal) use ($bill) {
|
|
return $journal->bill_id === $bill->id;
|
|
}
|
|
);
|
|
$first = $entry->first();
|
|
if (!is_null($first)) {
|
|
$billLine->setTransactionJournalId($first->id);
|
|
$billLine->setAmount($first->journalAmount);
|
|
$billLine->setHit(true);
|
|
}
|
|
|
|
// non active AND non hit? do not add:
|
|
if ($billLine->isActive() || $billLine->isHit()) {
|
|
$collection->addBill($billLine);
|
|
}
|
|
}
|
|
|
|
return $collection;
|
|
}
|
|
|
|
/**
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
* @param Collection $accounts
|
|
*
|
|
* @return CategoryCollection
|
|
*/
|
|
public function getCategoryReport(Carbon $start, Carbon $end, Collection $accounts): CategoryCollection
|
|
{
|
|
$object = new CategoryCollection;
|
|
/** @var CategoryRepositoryInterface $repository */
|
|
$repository = app(CategoryRepositoryInterface::class);
|
|
$categories = $repository->getCategories();
|
|
|
|
/** @var Category $category */
|
|
foreach ($categories as $category) {
|
|
$spent = $repository->spentInPeriod(new Collection([$category]), $accounts, $start, $end);
|
|
// CategoryCollection expects the amount in $spent:
|
|
$category->spent = $spent;
|
|
$object->addCategory($category);
|
|
}
|
|
|
|
return $object;
|
|
}
|
|
|
|
/**
|
|
* Get a full report on the users expenses during the period for a list of accounts.
|
|
*
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
* @param Collection $accounts
|
|
*
|
|
* @return Expense
|
|
*/
|
|
public function getExpenseReport(Carbon $start, Carbon $end, Collection $accounts): Expense
|
|
{
|
|
$object = new Expense;
|
|
|
|
/** @var AccountTaskerInterface $tasker */
|
|
$tasker = app(AccountTaskerInterface::class);
|
|
$collection = $tasker->expenseReport($accounts, $accounts, $start, $end);
|
|
|
|
/** @var stdClass $entry */
|
|
foreach ($collection as $entry) {
|
|
$object->addToTotal($entry->amount);
|
|
$object->addOrCreateExpense($entry);
|
|
}
|
|
|
|
return $object;
|
|
}
|
|
|
|
/**
|
|
* Get a full report on the users incomes during the period for the given accounts.
|
|
*
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
* @param Collection $accounts
|
|
*
|
|
* @return Income
|
|
*/
|
|
public function getIncomeReport(Carbon $start, Carbon $end, Collection $accounts): Income
|
|
{
|
|
$object = new Income;
|
|
/** @var AccountTaskerInterface $tasker */
|
|
$tasker = app(AccountTaskerInterface::class);
|
|
$collection = $tasker->incomeReport($accounts, $accounts, $start, $end);
|
|
|
|
/** @var stdClass $entry */
|
|
foreach ($collection as $entry) {
|
|
$object->addToTotal($entry->amount);
|
|
$object->addOrCreateIncome($entry);
|
|
}
|
|
|
|
return $object;
|
|
}
|
|
|
|
/**
|
|
* @param Carbon $date
|
|
*
|
|
* @return array
|
|
*/
|
|
public function listOfMonths(Carbon $date): array
|
|
{
|
|
/** @var FiscalHelperInterface $fiscalHelper */
|
|
$fiscalHelper = app(FiscalHelperInterface::class);
|
|
$start = clone $date;
|
|
$start->startOfMonth();
|
|
$end = Carbon::now();
|
|
$end->endOfMonth();
|
|
$months = [];
|
|
|
|
while ($start <= $end) {
|
|
$year = $fiscalHelper->endOfFiscalYear($start)->year; // current year
|
|
if (!isset($months[$year])) {
|
|
$months[$year] = [
|
|
'fiscal_start' => $fiscalHelper->startOfFiscalYear($start)->format('Y-m-d'),
|
|
'fiscal_end' => $fiscalHelper->endOfFiscalYear($start)->format('Y-m-d'),
|
|
'start' => Carbon::createFromDate($year, 1, 1)->format('Y-m-d'),
|
|
'end' => Carbon::createFromDate($year, 12, 31)->format('Y-m-d'),
|
|
'months' => [],
|
|
];
|
|
}
|
|
|
|
$currentEnd = clone $start;
|
|
$currentEnd->endOfMonth();
|
|
$months[$year]['months'][] = [
|
|
'formatted' => $start->formatLocalized('%B %Y'),
|
|
'start' => $start->format('Y-m-d'),
|
|
'end' => $currentEnd->format('Y-m-d'),
|
|
'month' => $start->month,
|
|
'year' => $year,
|
|
];
|
|
|
|
$start = clone $currentEnd; // to make the hop to the next month properly
|
|
$start->addDay();
|
|
}
|
|
|
|
return $months;
|
|
}
|
|
|
|
/**
|
|
* Returns an array of tags and their comparitive size with amounts bla bla.
|
|
*
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
* @param Collection $accounts
|
|
*
|
|
* @return array
|
|
*/
|
|
public function tagReport(Carbon $start, Carbon $end, Collection $accounts): array
|
|
{
|
|
$ids = $accounts->pluck('id')->toArray();
|
|
$set = Tag::
|
|
leftJoin('tag_transaction_journal', 'tags.id', '=', 'tag_transaction_journal.tag_id')
|
|
->leftJoin('transaction_journals', 'tag_transaction_journal.transaction_journal_id', '=', 'transaction_journals.id')
|
|
->leftJoin(
|
|
'transactions AS source', function (JoinClause $join) {
|
|
$join->on('source.transaction_journal_id', '=', 'transaction_journals.id')->where('source.amount', '<', '0');
|
|
}
|
|
)
|
|
->leftJoin(
|
|
'transactions AS destination', function (JoinClause $join) {
|
|
$join->on('destination.transaction_journal_id', '=', 'transaction_journals.id')->where('destination.amount', '>', '0');
|
|
}
|
|
)
|
|
->where('transaction_journals.date', '>=', $start->format('Y-m-d'))
|
|
->where('transaction_journals.date', '<=', $end->format('Y-m-d'))
|
|
->where(
|
|
// source.account_id in accountIds XOR destination.account_id in accountIds
|
|
function (Builder $query) use ($ids) {
|
|
$query->where(
|
|
function (Builder $q1) use ($ids) {
|
|
$q1->whereIn('source.account_id', $ids)
|
|
->whereNotIn('destination.account_id', $ids);
|
|
}
|
|
)->orWhere(
|
|
function (Builder $q2) use ($ids) {
|
|
$q2->whereIn('destination.account_id', $ids)
|
|
->whereNotIn('source.account_id', $ids);
|
|
}
|
|
);
|
|
}
|
|
)
|
|
->get(['tags.id', 'tags.tag', 'transaction_journals.id as journal_id', 'destination.amount']);
|
|
$collection = [];
|
|
if ($set->count() === 0) {
|
|
return $collection;
|
|
}
|
|
/** @var Tag $entry */
|
|
foreach ($set as $entry) {
|
|
// less than zero? multiply to be above zero.
|
|
$amount = $entry->amount;
|
|
$id = intval($entry->id);
|
|
$previousAmount = $collection[$id]['amount'] ?? '0';
|
|
$collection[$id] = [
|
|
'id' => $id,
|
|
'tag' => $entry->tag,
|
|
'amount' => bcadd($previousAmount, $amount),
|
|
];
|
|
}
|
|
|
|
// cleanup collection (match "fonts")
|
|
$max = strval(max(array_column($collection, 'amount')));
|
|
foreach ($collection as $id => $entry) {
|
|
$size = bcdiv($entry['amount'], $max, 4);
|
|
if (bccomp($size, '0.25') === -1) {
|
|
$size = '0.5';
|
|
}
|
|
$collection[$id]['fontsize'] = $size;
|
|
}
|
|
|
|
return $collection;
|
|
}
|
|
|
|
}
|