mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-09-06 12:45:30 +00:00
87 lines
2.8 KiB
PHP
87 lines
2.8 KiB
PHP
<?php
|
|
/**
|
|
* OperationsRepositoryInterface.php
|
|
* Copyright (c) 2019 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\Repositories\Account;
|
|
|
|
use Carbon\Carbon;
|
|
use FireflyIII\User;
|
|
use Illuminate\Support\Collection;
|
|
|
|
/**
|
|
* Interface OperationsRepositoryInterface
|
|
*/
|
|
interface OperationsRepositoryInterface
|
|
{
|
|
/**
|
|
* This method returns a list of all the withdrawal transaction journals (as arrays) set in that period
|
|
* which have the specified accounts. It's grouped per currency, with as few details in the array
|
|
* as possible. Amounts are always negative.
|
|
*
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
* @param Collection $accounts
|
|
*
|
|
* @return array
|
|
*/
|
|
public function listExpenses(Carbon $start, Carbon $end, Collection $accounts): array;
|
|
|
|
/**
|
|
* This method returns a list of all the deposit transaction journals (as arrays) set in that period
|
|
* which have the specified accounts. It's grouped per currency, with as few details in the array
|
|
* as possible. Amounts are always positive.
|
|
*
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
* @param Collection|null $accounts
|
|
*
|
|
* @return array
|
|
*/
|
|
public function listIncome(Carbon $start, Carbon $end, ?Collection $accounts = null): array;
|
|
|
|
/**
|
|
* @param User $user
|
|
*/
|
|
public function setUser(User $user): void;
|
|
|
|
/**
|
|
* Sum of withdrawal journals in period for a set of accounts, grouped per currency. Amounts are always negative.
|
|
*
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
* @param Collection|null $accounts
|
|
*
|
|
* @return array
|
|
*/
|
|
public function sumExpenses(Carbon $start, Carbon $end, ?Collection $accounts = null): array;
|
|
|
|
/**
|
|
* Sum of income journals in period for a set of accounts, grouped per currency. Amounts are always positive.
|
|
*
|
|
* @param Carbon $start
|
|
* @param Carbon $end
|
|
* @param Collection|null $accounts
|
|
*
|
|
* @return array
|
|
*/
|
|
public function sumIncome(Carbon $start, Carbon $end, ?Collection $accounts = null): array;
|
|
} |