2015-02-09 07:23:39 +01:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace FireflyIII\Repositories\Account;
|
|
|
|
|
2015-03-29 21:27:51 +02:00
|
|
|
use Carbon\Carbon;
|
2015-02-14 14:25:29 +01:00
|
|
|
use FireflyIII\Models\Account;
|
2015-03-13 08:44:07 +01:00
|
|
|
use FireflyIII\Models\Preference;
|
2015-04-03 09:30:44 +02:00
|
|
|
use FireflyIII\Models\Transaction;
|
2015-03-29 21:27:51 +02:00
|
|
|
use FireflyIII\Models\TransactionJournal;
|
2015-04-07 18:48:34 +02:00
|
|
|
use Illuminate\Pagination\LengthAwarePaginator;
|
2015-03-13 08:44:07 +01:00
|
|
|
use Illuminate\Support\Collection;
|
2015-03-29 21:27:51 +02:00
|
|
|
|
2015-02-11 07:35:10 +01:00
|
|
|
/**
|
|
|
|
* Interface AccountRepositoryInterface
|
|
|
|
*
|
|
|
|
* @package FireflyIII\Repositories\Account
|
|
|
|
*/
|
2015-02-09 07:23:39 +01:00
|
|
|
interface AccountRepositoryInterface
|
|
|
|
{
|
2015-04-04 21:23:37 +02:00
|
|
|
/**
|
|
|
|
* @param array $types
|
|
|
|
*
|
|
|
|
* @return int
|
|
|
|
*/
|
|
|
|
public function countAccounts(array $types);
|
|
|
|
|
2015-02-14 14:25:29 +01:00
|
|
|
/**
|
|
|
|
* @param Account $account
|
|
|
|
*
|
|
|
|
* @return boolean
|
|
|
|
*/
|
|
|
|
public function destroy(Account $account);
|
|
|
|
|
2015-03-13 08:44:07 +01:00
|
|
|
/**
|
2015-04-04 21:23:37 +02:00
|
|
|
* @param array $types
|
|
|
|
*
|
|
|
|
* @return mixed
|
|
|
|
*/
|
2015-04-11 15:01:42 +02:00
|
|
|
public function getAccounts(array $types);
|
2015-04-04 21:23:37 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @param TransactionJournal $journal
|
|
|
|
* @param Account $account
|
|
|
|
*
|
|
|
|
* @return Transaction
|
2015-03-13 08:44:07 +01:00
|
|
|
*/
|
2015-04-04 21:23:37 +02:00
|
|
|
public function getFirstTransaction(TransactionJournal $journal, Account $account);
|
2015-03-13 08:44:07 +01:00
|
|
|
|
2015-04-07 10:14:10 +02:00
|
|
|
/**
|
|
|
|
* @return Collection
|
|
|
|
*/
|
|
|
|
public function getCreditCards();
|
|
|
|
|
2015-04-13 20:43:58 +02:00
|
|
|
/**
|
|
|
|
* Get the accounts of a user that have piggy banks connected to them.
|
|
|
|
*
|
|
|
|
* @return Collection
|
|
|
|
*/
|
|
|
|
public function getPiggyBankAccounts();
|
|
|
|
|
|
|
|
|
2015-04-07 10:14:10 +02:00
|
|
|
/**
|
|
|
|
* Get all transfers TO this account in this range.
|
|
|
|
*
|
|
|
|
* @param Account $account
|
|
|
|
* @param Carbon $start
|
|
|
|
* @param Carbon $end
|
|
|
|
*
|
|
|
|
* @return Collection
|
|
|
|
*/
|
|
|
|
public function getTransfersInRange(Account $account, Carbon $start, Carbon $end);
|
|
|
|
|
2015-03-13 08:44:07 +01:00
|
|
|
/**
|
|
|
|
* @param Preference $preference
|
|
|
|
*
|
|
|
|
* @return Collection
|
|
|
|
*/
|
|
|
|
public function getFrontpageAccounts(Preference $preference);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param Account $account
|
|
|
|
* @param Carbon $start
|
|
|
|
* @param Carbon $end
|
|
|
|
*
|
|
|
|
* @return mixed
|
|
|
|
*/
|
|
|
|
public function getFrontpageTransactions(Account $account, Carbon $start, Carbon $end);
|
|
|
|
|
2015-02-14 14:25:29 +01:00
|
|
|
/**
|
|
|
|
* @param Account $account
|
2015-05-05 10:23:01 +02:00
|
|
|
* @param $page
|
2015-02-14 14:25:29 +01:00
|
|
|
*
|
2015-04-07 18:48:34 +02:00
|
|
|
* @return LengthAwarePaginator
|
2015-02-14 14:25:29 +01:00
|
|
|
*/
|
2015-03-02 20:05:28 +01:00
|
|
|
public function getJournals(Account $account, $page);
|
2015-02-14 14:25:29 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @param Account $account
|
|
|
|
*
|
2015-04-04 21:23:37 +02:00
|
|
|
* @return Carbon|null
|
2015-02-14 14:25:29 +01:00
|
|
|
*/
|
2015-04-04 21:23:37 +02:00
|
|
|
public function getLastActivity(Account $account);
|
2015-02-14 14:25:29 +01:00
|
|
|
|
2015-04-07 20:54:43 +02:00
|
|
|
/**
|
|
|
|
* @return float
|
|
|
|
*/
|
|
|
|
public function sumOfEverything();
|
|
|
|
|
2015-02-21 12:16:41 +01:00
|
|
|
/**
|
2015-04-04 21:23:37 +02:00
|
|
|
* Get savings accounts and the balance difference in the period.
|
2015-02-21 12:16:41 +01:00
|
|
|
*
|
2015-04-04 21:23:37 +02:00
|
|
|
* @return Collection
|
2015-02-21 12:16:41 +01:00
|
|
|
*/
|
2015-04-04 21:23:37 +02:00
|
|
|
public function getSavingsAccounts();
|
2015-02-14 14:25:29 +01:00
|
|
|
|
2015-02-21 12:16:41 +01:00
|
|
|
/**
|
|
|
|
* @param Account $account
|
|
|
|
*
|
2015-04-04 21:23:37 +02:00
|
|
|
* @return float
|
2015-02-21 12:16:41 +01:00
|
|
|
*/
|
2015-04-04 21:23:37 +02:00
|
|
|
public function leftOnAccount(Account $account);
|
2015-02-24 21:10:25 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @param Account $account
|
|
|
|
*
|
2015-04-04 21:23:37 +02:00
|
|
|
* @return TransactionJournal|null
|
2015-02-24 21:10:25 +01:00
|
|
|
*/
|
2015-04-04 21:23:37 +02:00
|
|
|
public function openingBalanceTransaction(Account $account);
|
2015-03-21 08:51:34 +01:00
|
|
|
|
|
|
|
/**
|
2015-04-04 21:23:37 +02:00
|
|
|
* @param array $data
|
2015-03-21 08:51:34 +01:00
|
|
|
*
|
2015-04-04 21:23:37 +02:00
|
|
|
* @return Account
|
2015-03-21 08:51:34 +01:00
|
|
|
*/
|
2015-04-04 21:23:37 +02:00
|
|
|
public function store(array $data);
|
2015-04-03 09:30:44 +02:00
|
|
|
|
|
|
|
/**
|
2015-04-04 21:23:37 +02:00
|
|
|
* @param Account $account
|
|
|
|
* @param array $data
|
2015-04-03 09:30:44 +02:00
|
|
|
*
|
2015-04-04 21:23:37 +02:00
|
|
|
* @return Account
|
2015-04-03 09:30:44 +02:00
|
|
|
*/
|
2015-04-04 21:23:37 +02:00
|
|
|
public function update(Account $account, array $data);
|
2015-03-29 08:14:32 +02:00
|
|
|
}
|