mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-01-03 12:47:17 -06:00
85 lines
2.2 KiB
PHP
85 lines
2.2 KiB
PHP
<?php
|
|
declare(strict_types = 1);
|
|
|
|
namespace FireflyIII\Helpers\Report;
|
|
|
|
use Carbon\Carbon;
|
|
use FireflyIII\Helpers\Collection\Bill as BillCollection;
|
|
use FireflyIII\Helpers\Collection\Category as CategoryCollection;
|
|
use FireflyIII\Helpers\Collection\Expense;
|
|
use FireflyIII\Helpers\Collection\Income;
|
|
use Illuminate\Support\Collection;
|
|
|
|
/**
|
|
* Interface ReportHelperInterface
|
|
*
|
|
* @package FireflyIII\Helpers\Report
|
|
*/
|
|
interface ReportHelperInterface
|
|
{
|
|
|
|
/**
|
|
* 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);
|
|
|
|
/**
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
* @param Collection $accounts
|
|
*
|
|
* @return CategoryCollection
|
|
*/
|
|
public function getCategoryReport(Carbon $start, Carbon $end, Collection $accounts);
|
|
|
|
/**
|
|
* 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);
|
|
|
|
/**
|
|
* 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);
|
|
|
|
/**
|
|
* @param Carbon $date
|
|
*
|
|
* @return array
|
|
*/
|
|
public function listOfMonths(Carbon $date);
|
|
|
|
/**
|
|
* 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;
|
|
|
|
}
|