firefly-iii/app/Repositories/Account/AccountTaskerInterface.php

99 lines
2.6 KiB
PHP
Raw Normal View History

2016-10-08 07:54:32 -05:00
<?php
/**
* AccountTaskerInterface.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\Repositories\Account;
2016-10-08 09:04:05 -05:00
use Carbon\Carbon;
use FireflyIII\Helpers\Collection\Account as AccountCollection;
use Illuminate\Support\Collection;
2016-10-08 07:54:32 -05:00
/**
* Interface AccountTaskerInterface
*
* @package FireflyIII\Repositories\Account
*/
interface AccountTaskerInterface
{
2016-10-09 00:58:27 -05:00
/**
* @param Collection $accounts
* @param Collection $excluded
* @param Carbon $start
* @param Carbon $end
*
* @see AccountTasker::amountInPeriod()
*
* @return string
*/
public function amountInInPeriod(Collection $accounts, Collection $excluded, Carbon $start, Carbon $end): string;
/**
* @param Collection $accounts
* @param Collection $excluded
* @param Carbon $start
* @param Carbon $end
*
* @see AccountTasker::amountInPeriod()
*
* @return string
*/
public function amountOutInPeriod(Collection $accounts, Collection $excluded, Carbon $start, Carbon $end): string;
/**
* @param Collection $accounts
* @param Collection $excluded
* @param Carbon $start
* @param Carbon $end
*
* @see AccountTasker::financialReport()
*
* @return Collection
*
*/
public function expenseReport(Collection $accounts, Collection $excluded, Carbon $start, Carbon $end): Collection;
2016-10-09 09:22:08 -05:00
/**
* @param Carbon $start
* @param Carbon $end
2016-10-10 00:49:39 -05:00
* @param Collection $accounts
2016-10-09 09:22:08 -05:00
*
2016-10-10 00:49:39 -05:00
* @return AccountCollection
2016-10-09 09:22:08 -05:00
*/
2016-10-10 00:49:39 -05:00
public function getAccountReport(Carbon $start, Carbon $end, Collection $accounts): AccountCollection;
2016-10-09 09:22:08 -05:00
2016-10-08 09:04:05 -05:00
/**
2016-10-10 00:49:39 -05:00
* Experimental getJournals method.
*
* @param Collection $accounts
* @param array $types
2016-10-08 09:04:05 -05:00
* @param Carbon $start
* @param Carbon $end
*
2016-10-10 00:49:39 -05:00
* @return Collection
2016-10-08 09:04:05 -05:00
*/
2016-10-10 00:49:39 -05:00
public function getJournalsInPeriod(Collection $accounts, array $types, Carbon $start, Carbon $end): Collection;
2016-10-08 09:04:05 -05:00
/**
* @param Collection $accounts
* @param Collection $excluded
* @param Carbon $start
* @param Carbon $end
*
* @see AccountTasker::financialReport()
*
* @return Collection
*
*/
public function incomeReport(Collection $accounts, Collection $excluded, Carbon $start, Carbon $end): Collection;
2016-10-08 07:54:32 -05:00
}