Firefly III: a personal finances manager
PHP accountingbudgetbudgetingbudgetscash-flowcashflowcredit-carddockerexpensesfinancefinancesfinanciallinuxmoneypaycheckpersonal-financephpphp7
<?php
/**
* MonthReportGenerator.php
* Copyright (c) 2019 [email protected]
*
* 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\Generator\Report\Budget;
use Carbon\Carbon;
use FireflyIII\Enums\TransactionTypeEnum;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Generator\Report\ReportGeneratorInterface;
use FireflyIII\Helpers\Collector\GroupCollectorInterface;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Log;
use Throwable;
/**
* Class MonthReportGenerator.
* TODO include info about tags.
*/
class MonthReportGenerator implements ReportGeneratorInterface
{
private Collection $accounts;
private Collection $budgets;
private Carbon $end;
private array $expenses = [];
private Carbon $start;
/**
* Generates the report.
*
* @throws FireflyException
*/
public function generate(): string
{
$accountIds = implode(',', $this->accounts->pluck('id')->toArray());
$budgetIds = implode(',', $this->budgets->pluck('id')->toArray());
try {
$result = view('reports.budget.month', ['accountIds' => $accountIds, 'budgetIds' => $budgetIds])
->with('start', $this->start)
->with('end', $this->end)
->with('budgets', $this->budgets)
->with('accounts', $this->accounts)
->render()
;
} catch (Throwable $e) {
Log::error(sprintf('Cannot render reports.account.report: %s', $e->getMessage()));
Log::error($e->getTraceAsString());
$result = sprintf('Could not render report view: %s', $e->getMessage());
throw new FireflyException($result, 0, $e);
}
return $result;
}
/**
* Set the involved accounts.
*/
public function setAccounts(Collection $accounts): ReportGeneratorInterface
{
$this->accounts = $accounts;
return $this;
}
/**
* Set the involved budgets.
*/
public function setBudgets(Collection $budgets): ReportGeneratorInterface
{
$this->budgets = $budgets;
return $this;
}
/**
* Unused category setter.
*/
public function setCategories(Collection $categories): ReportGeneratorInterface
{
return $this;
}
/**
* Set the end date of the report.
*/
public function setEndDate(Carbon $date): ReportGeneratorInterface
{
$this->end = $date;
return $this;
}
/**
* Unused expense setter.
*/
public function setExpense(Collection $expense): ReportGeneratorInterface
{
return $this;
}
/**
* Set the start date of the report.
*/
public function setStartDate(Carbon $date): ReportGeneratorInterface
{
$this->start = $date;
return $this;
}
/**
* Unused tags setter.
*/
public function setTags(Collection $tags): ReportGeneratorInterface
{
return $this;
}
/**
* Get the expenses.
*/
protected function getExpenses(): array
{
if (0 !== count($this->expenses)) {
Log::debug('Return previous set of expenses.');
return $this->expenses;
}
/** @var GroupCollectorInterface $collector */
$collector = app(GroupCollectorInterface::class);
$collector
->setAccounts($this->accounts)
->setRange($this->start, $this->end)
->setTypes([TransactionTypeEnum::WITHDRAWAL->value])
->withAccountInformation()
->withBudgetInformation()
->setBudgets($this->budgets)
;
$journals = $collector->getExtractedJournals();
$this->expenses = $journals;
return $journals;
}
}