kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-11-16 22:58:09 +00:00
Code Issues Projects Releases Wiki Activity

Refactoring.

Browse Source
This commit is contained in:
James Cole
2016-05-13 15:53:39 +02:00
parent 36bc483edb
commit 20e1e50032
31 changed files with 526 additions and 392 deletions
Download Patch File Download Diff File Expand all files Collapse all files

311
app/Repositories/Account/AccountRepository.php
View File

@@ -8,7 +8,6 @@ use FireflyIII\Models\Account;
use FireflyIII\Models\AccountMeta;
use FireflyIII\Models\AccountType;
use FireflyIII\Models\PiggyBank;
use FireflyIII\Models\Preference;
use FireflyIII\Models\Transaction;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\Models\TransactionType;
@@ -77,6 +76,23 @@ class AccountRepository implements AccountRepositoryInterface
return true;
}
/**
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
*
* @return string
*/
public function earnedInPeriod(Collection $accounts, Carbon $start, Carbon $end): string
{
Log::debug('earnedinperiod');
$types = [TransactionType::DEPOSIT, TransactionType::TRANSFER];
$sum = bcmul($this->sumInPeriod($accounts, $types, $start, $end), '-1');
return $sum;
}
/**
* @param $accountId
*
@@ -92,6 +108,29 @@ class AccountRepository implements AccountRepositoryInterface
return $account;
}
/**
* @param Account $account
*
* @return Carbon
*/
public function firstUseDate(Account $account): Carbon
{
$first = new Carbon('1900-01-01');
/** @var Transaction $first */
$date = $account->transactions()
->leftJoin('transaction_journals', 'transaction_journals.id', '=', 'transactions.transaction_journal_id')
->orderBy('transaction_journals.date', 'ASC')
->orderBy('transaction_journals.order', 'DESC')
->orderBy('transaction_journals.id', 'ASC')
->first(['transaction_journals.date']);
if (!is_null($date)) {
$first = new Carbon($date->date);
}
return $first;
}
/**
* Gets all the accounts by ID, for a given set.
*
@@ -105,11 +144,11 @@ class AccountRepository implements AccountRepositoryInterface
}
/**
* @param array $types
* @param array $accountIds
*
* @return Collection
*/
public function getAccounts(array $types): Collection
public function getAccountsById(array $accountIds): Collection
{
/** @var Collection $result */
$query = $this->user->accounts()->with(
@@ -117,9 +156,11 @@ class AccountRepository implements AccountRepositoryInterface
$query->where('name', 'accountRole');
}]
);
if (count($types) > 0) {
$query->accountTypeIn($types);
if (count($accountIds) > 0) {
$query->whereIn('accounts.id', $accountIds);
}
$result = $query->get(['accounts.*']);
$result = $result->sortBy(
@@ -132,72 +173,31 @@ class AccountRepository implements AccountRepositoryInterface
}
/**
* This method returns the users credit cards, along with some basic information about the
* balance they have on their CC. To be used in the JSON boxes on the front page that say
* how many bills there are still left to pay. The balance will be saved in field "balance".
*
* To get the balance, the field "date" is necessary.
*
* @param Carbon $date
* @param array $types
*
* @return Collection
*/
public function getCreditCards(Carbon $date): Collection
public function getAccountsByType(array $types): Collection
{
$set = $this->user->accounts()
->hasMetaValue('accountRole', 'ccAsset')
->hasMetaValue('ccType', 'monthlyFull')
->leftJoin('transactions', 'transactions.account_id', '=', 'accounts.id')
->leftJoin('transaction_journals', 'transaction_journals.id', '=', 'transactions.transaction_journal_id')
->whereNull('transactions.deleted_at')
->where('transaction_journals.date', '<=', $date->format('Y-m-d'))
->groupBy('accounts.id')
->get(
[
'accounts.*',
'ccType.data as ccType',
'accountRole.data as accountRole',
DB::Raw('SUM(`transactions`.`amount`) AS `balance`'),
]
);
/** @var Collection $result */
$query = $this->user->accounts()->with(
['accountmeta' => function (HasMany $query) {
$query->where('name', 'accountRole');
}]
);
if (count($types) > 0) {
$query->accountTypeIn($types);
}
return $set;
}
$result = $query->get(['accounts.*']);
/**
* Returns a list of transactions TO the $account, not including transfers
* and/or expenses in the $accounts list.
*
* @param Account $account
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
*
* @return Collection
*/
public function getExpensesByDestination(Account $account, Collection $accounts, Carbon $start, Carbon $end): Collection
{
$ids = $accounts->pluck('id')->toArray();
$journals = $this->user->transactionjournals()
->expanded()
->sortCorrectly()
->before($end)
->leftJoin(
'transactions as dest', function (JoinClause $join) {
$join->on('dest.transaction_journal_id', '=', 'transaction_journals.id')->where('dest.amount', '>', 0);
}
)
->leftJoin(
'transactions as source', function (JoinClause $join) {
$join->on('source.transaction_journal_id', '=', 'transaction_journals.id')->where('source.amount', '<', 0);
}
)
->where('dest.account_id', $account->id)
->whereIn('source.account_id', $ids)
->after($start)
->get(TransactionJournal::queryFields());
$result = $result->sortBy(
function (Account $account) {
return strtolower($account->name);
}
);
return $journals;
return $result;
}
/**
@@ -216,80 +216,6 @@ class AccountRepository implements AccountRepositoryInterface
return $transaction;
}
/**
* @param Preference $preference
*
* @return Collection
*/
public function getFrontpageAccounts(Preference $preference): Collection
{
$query = $this->user->accounts()->accountTypeIn(['Default account', 'Asset account']);
if (count($preference->data) > 0) {
$query->whereIn('accounts.id', $preference->data);
}
$result = $query->get(['accounts.*']);
return $result;
}
/**
*
* @param Account $account
* @param Carbon $start
* @param Carbon $end
*
* @return mixed
*/
public function getFrontpageTransactions(Account $account, Carbon $start, Carbon $end): Collection
{
$query = $this->user
->transactionjournals()
->expanded()
->sortCorrectly()
->before($end)
->after($start)
->take(10);
// expand query:
$query->leftJoin(
'transactions as source', function (JoinClause $join) {
$join->on('source.transaction_journal_id', '=', 'transaction_journals.id');
}
)->where('source.account_id', $account->id);
$query->take(10);
$set = $query->get(TransactionJournal::queryFields());
return $set;
}
/**
* Returns a list of transactions TO the given (asset) $account, but none from the
* given list of accounts
*
* @param Account $account
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
*
* @return Collection
*/
public function getIncomeByDestination(Account $account, Collection $accounts, Carbon $start, Carbon $end): Collection
{
$ids = $accounts->pluck('id')->toArray();
$journals = $this->user->transactionjournals()
->expanded()
->sortCorrectly()
->before($end)
->where('source_account.id', $account->id)
->whereIn('destination_account.id', $ids)
->after($start)
->get(TransactionJournal::queryFields());
return $journals;
}
/**
* @param Account $account
* @param int $page
@@ -435,7 +361,38 @@ class AccountRepository implements AccountRepositoryInterface
}
/**
*
* @param Collection $accounts
* @param array $types
* @param Carbon $start
* @param Carbon $end
*
* @return Collection
*/
public function journalsInPeriod(Collection $accounts, array $types, Carbon $start, Carbon $end): Collection
{
// first collect actual transaction journals (fairly easy)
$query = $this->user->transactionjournals()->expanded()->sortCorrectly();
if ($end >= $start) {
$query->before($end)->after($start);
}
if (count($types) > 0) {
$query->transactionTypes($types);
}
if ($accounts->count() > 0) {
$accountIds = $accounts->pluck('id')->toArray();
$query->leftJoin('transactions as t', 't.transaction_journal_id', '=', 'transaction_journals.id');
$query->whereIn('t.account_id', $accountIds);
}
// that should do it:
$complete = $query->get(TransactionJournal::queryFields());
return $complete;
}
/**
*
* @param Account $account
* @param Carbon $date
*
@@ -524,6 +481,22 @@ class AccountRepository implements AccountRepositoryInterface
return $journal;
}
/**
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
*
* @return string
*/
public function spentInPeriod(Collection $accounts, Carbon $start, Carbon $end): string
{
Log::debug('spentinperiod');
$types = [TransactionType::WITHDRAWAL, TransactionType::TRANSFER];
$sum = $this->sumInPeriod($accounts, $types, $start, $end);
return $sum;
}
/**
* @param array $data
*
@@ -788,4 +761,64 @@ class AccountRepository implements AccountRepositoryInterface
}
}
/**
* @param Collection $accounts
* @param array $types
* @param Carbon $start
* @param Carbon $end
*
* @return string
*/
private function sumInPeriod(Collection $accounts, array $types, Carbon $start, Carbon $end): string
{
// first collect incoming transaction journals (where the $accounts receive the money).
$query = $this->user
->transactionjournals()
->distinct()
->transactionTypes($types)
->leftJoin(
'transactions as t', function (JoinClause $join) {
$join->on('t.transaction_journal_id', '=', 'transaction_journals.id')->where('amount', '>', 0);
}
);
if ($end >= $start) {
$query->before($end)->after($start);
}
if ($accounts->count() > 0) {
$accountIds = $accounts->pluck('id')->toArray();
$query->whereIn('t.account_id', $accountIds);
}
// that should do it:
$first = strval($query->sum('t.amount'));
// the the other way around:
$query = $this->user
->transactionjournals()
->distinct()
->transactionTypes($types)
->leftJoin(
'transactions as t', function (JoinClause $join) {
$join->on('t.transaction_journal_id', '=', 'transaction_journals.id')->where('amount', '<', 0);
}
);
if ($end >= $start) {
$query->before($end)->after($start);
}
if ($accounts->count() > 0) {
$accountIds = $accounts->pluck('id')->toArray();
$query->whereIn('t.account_id', $accountIds);
}
// that should do it:
$second = strval($query->sum('t.amount'));
$sum = bcadd($first, $second);
Log::debug('SumInPeriodData ', ['accounts' => $accountIds, 'first' => $first, 'second' => $second, 'sum' => $sum]);
return $sum;
}
}

114
app/Repositories/Account/AccountRepositoryInterface.php
View File

@@ -6,7 +6,6 @@ namespace FireflyIII\Repositories\Account;
use Carbon\Carbon;
use FireflyIII\Models\Account;
use FireflyIII\Models\AccountMeta;
use FireflyIII\Models\Preference;
use FireflyIII\Models\Transaction;
use FireflyIII\Models\TransactionJournal;
use Illuminate\Pagination\LengthAwarePaginator;
@@ -35,6 +34,15 @@ interface AccountRepositoryInterface
*/
public function destroy(Account $account, Account $moveTo): bool;
/**
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
*
* @return string
*/
public function earnedInPeriod(Collection $accounts, Carbon $start, Carbon $end): string;
/**
* @param int $accountId
*
@@ -42,6 +50,13 @@ interface AccountRepositoryInterface
*/
public function find(int $accountId): Account;
/**
* @param Account $account
*
* @return Carbon
*/
public function firstUseDate(Account $account): Carbon;
/**
* Gets all the accounts by ID, for a given set.
*
@@ -51,38 +66,19 @@ interface AccountRepositoryInterface
*/
public function get(array $ids): Collection;
/**
* @param array $accountIds
*
* @return Collection
*/
public function getAccountsById(array $accountIds): Collection;
/**
* @param array $types
*
* @return Collection
*/
public function getAccounts(array $types): Collection;
/**
* This method returns the users credit cards, along with some basic information about the
* balance they have on their CC. To be used in the JSON boxes on the front page that say
* how many bills there are still left to pay. The balance will be saved in field "balance".
*
* To get the balance, the field "date" is necessary.
*
* @param Carbon $date
*
* @return Collection
*/
public function getCreditCards(Carbon $date): Collection;
/**
* Returns a list of transactions TO the given (expense) $account, all from the
* given list of accounts
*
* @param Account $account
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
*
* @return Collection
*/
public function getExpensesByDestination(Account $account, Collection $accounts, Carbon $start, Carbon $end): Collection;
public function getAccountsByType(array $types): Collection;
/**
* @param TransactionJournal $journal
@@ -93,35 +89,10 @@ interface AccountRepositoryInterface
public function getFirstTransaction(TransactionJournal $journal, Account $account): Transaction;
/**
* @param Preference $preference
* @deprecated
*
* @return Collection
*/
public function getFrontpageAccounts(Preference $preference): Collection;
/**
* @param Account $account
* @param Carbon $start
* @param Carbon $end
* SEE OTHER GETJOURNALS METHODS.
*
* @return Collection
*/
public function getFrontpageTransactions(Account $account, Carbon $start, Carbon $end): Collection;
/**
* Returns a list of transactions TO the given (asset) $account, but none from the
* given list of accounts
*
* @param Account $account
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
*
* @return Collection
*/
public function getIncomeByDestination(Account $account, Collection $accounts, Carbon $start, Carbon $end): Collection;
/**
* @param Account $account
* @param int $page
* @param int $pageSize
@@ -131,6 +102,10 @@ interface AccountRepositoryInterface
public function getJournals(Account $account, int $page, int $pageSize = 50): LengthAwarePaginator;
/**
* @deprecated
*
* SEE OTHER GETJOURNALS METHODS.
*
* @param Account $account
* @param Carbon $start
* @param Carbon $end
@@ -140,6 +115,8 @@ interface AccountRepositoryInterface
public function getJournalsInRange(Account $account, Carbon $start, Carbon $end): Collection;
/**
* @deprecated
*
* Get the accounts of a user that have piggy banks connected to them.
*
* @return Collection
@@ -147,6 +124,8 @@ interface AccountRepositoryInterface
public function getPiggyBankAccounts(): Collection;
/**
* @deprecated
*
* Get savings accounts and the balance difference in the period.
*
* @return Collection
@@ -154,6 +133,18 @@ interface AccountRepositoryInterface
public function getSavingsAccounts() : Collection;
/**
* @param Collection $accounts
* @param array $types
* @param Carbon $start
* @param Carbon $end
*
* @return Collection
*/
public function journalsInPeriod(Collection $accounts, array $types, Carbon $start, Carbon $end): Collection;
/**
* @deprecated
*
* @param Account $account
* @param Carbon $date
*
@@ -180,12 +171,23 @@ interface AccountRepositoryInterface
public function oldestJournalDate(Account $account): Carbon;
/**
*
*
* @param Account $account
*
* @return TransactionJournal
*/
public function openingBalanceTransaction(Account $account) : TransactionJournal;
/**
* @param Collection $accounts
* @param Carbon $start
* @param Carbon $end
*
* @return string
*/
public function spentInPeriod(Collection $accounts, Carbon $start, Carbon $end): string;
/**
* @param array $data
*
@@ -203,6 +205,8 @@ interface AccountRepositoryInterface
public function storeMeta(Account $account, string $name, $value): AccountMeta;
/**
* @deprecated
*
* @return string
*/
public function sumOfEverything() : string;

49
app/Repositories/Bill/BillRepository.php
View File

@@ -250,55 +250,6 @@ class BillRepository implements BillRepositoryInterface
return $amount;
}
/**
* This method will tell you if you still have a CC bill to pay. Amount will be positive if the amount
* has been paid, otherwise it will be negative.
*
* @param Carbon $start
* @param Carbon $end
*
* @return string
*/
public function getCreditCardBill(Carbon $start, Carbon $end): string
{
/** @var AccountRepositoryInterface $accountRepository */
$accountRepository = app(AccountRepositoryInterface::class);
$amount = '0';
$creditCards = $accountRepository->getCreditCards($end); // Find credit card accounts and possibly unpaid credit card bills.
/** @var Account $creditCard */
foreach ($creditCards as $creditCard) {
if ($creditCard->balance == 0) {
// find a transfer TO the credit card which should account for anything paid. If not, the CC is not yet used.
$set = TransactionJournal::whereIn(
'transaction_journals.id', function (Builder $q) use ($creditCard, $start, $end) {
$q->select('transaction_journals.id')
->from('transactions')
->leftJoin('transaction_journals', 'transaction_journals.id', '=', 'transactions.transaction_journal_id')
->leftJoin('transaction_types', 'transaction_types.id', '=', 'transaction_journals.transaction_type_id')
->where('transactions.account_id', $creditCard->id)
->where('transactions.amount', '>', 0)// this makes the filter unnecessary.
->where('transaction_journals.user_id', $this->user->id)
->where('transaction_journals.date', '>=', $start->format('Y-m-d'))
->where('transaction_journals.date', '<=', $end->format('Y-m-d'))
->where('transaction_types.type', TransactionType::TRANSFER);
}
)->leftJoin(
'transactions', function (JoinClause $join) {
$join->on('transactions.transaction_journal_id', '=', 'transaction_journals.id')->where('transactions.amount', '>', 0);
}
)->first([DB::raw('SUM(`transactions`.`amount`) as `sum_amount`')]);
$sumAmount = $set->sum_amount ?? '0';
$amount = bcadd($amount, $sumAmount);
} else {
$amount = bcadd($amount, $creditCard->balance);
}
}
return $amount;
}
/**
* This method also returns the amount of the journal in "journalAmount"
* for easy access.

11
app/Repositories/Bill/BillRepositoryInterface.php
View File

@@ -84,17 +84,6 @@ interface BillRepositoryInterface
*/
public function getBillsUnpaidInRange(Carbon $start, Carbon $end): string;
/**
* This method will tell you if you still have a CC bill to pay. Amount will be negative if the amount
* has been paid
*
* @param Carbon $start
* @param Carbon $end
*
* @return string
*/
public function getCreditCardBill(Carbon $start, Carbon $end): string;
/**
* @param Bill $bill
*