mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-01-08 15:14:06 -06:00
96 lines
2.5 KiB
PHP
96 lines
2.5 KiB
PHP
<?php
|
|
/**
|
|
* PopupReportInterface.php
|
|
* Copyright (c) 2017 thegrumpydictator@gmail.com
|
|
*
|
|
* This file is part of Firefly III.
|
|
*
|
|
* Firefly III is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Firefly III 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
declare(strict_types=1);
|
|
|
|
namespace FireflyIII\Helpers\Report;
|
|
|
|
use FireflyIII\Models\Account;
|
|
use FireflyIII\Models\Budget;
|
|
use FireflyIII\Models\Category;
|
|
use Illuminate\Support\Collection;
|
|
|
|
/**
|
|
* Interface PopupReportInterface.
|
|
*/
|
|
interface PopupReportInterface
|
|
{
|
|
/**
|
|
* Get balances for budget.
|
|
*
|
|
* @param Budget $budget
|
|
* @param Account $account
|
|
* @param array $attributes
|
|
*
|
|
* @return Collection
|
|
*/
|
|
public function balanceForBudget(Budget $budget, Account $account, array $attributes): Collection;
|
|
|
|
/**
|
|
* Get balances for transactions without a budget.
|
|
*
|
|
* @param Account $account
|
|
* @param array $attributes
|
|
*
|
|
* @return Collection
|
|
*/
|
|
public function balanceForNoBudget(Account $account, array $attributes): Collection;
|
|
|
|
/**
|
|
* Group by budget.
|
|
*
|
|
* @param Budget $budget
|
|
* @param array $attributes
|
|
*
|
|
* @return Collection
|
|
*/
|
|
public function byBudget(Budget $budget, array $attributes): Collection;
|
|
|
|
/**
|
|
* Group by category.
|
|
*
|
|
* @param Category $category
|
|
* @param array $attributes
|
|
*
|
|
* @return Collection
|
|
*/
|
|
public function byCategory(Category $category, array $attributes): Collection;
|
|
|
|
/**
|
|
* Do something with expense. Sorry, I am not very inspirational here.
|
|
*
|
|
* @param Account $account
|
|
* @param array $attributes
|
|
*
|
|
* @return Collection
|
|
*/
|
|
public function byExpenses(Account $account, array $attributes): Collection;
|
|
|
|
/**
|
|
* Do something with income. Sorry, I am not very inspirational here.
|
|
*
|
|
* @param Account $account
|
|
* @param array $attributes
|
|
*
|
|
* @return Collection
|
|
*/
|
|
public function byIncome(Account $account, array $attributes): Collection;
|
|
}
|