kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-10-25 21:16:47 +00:00
Code Issues Projects Releases Wiki Activity

Expand API to return transaction groups.

Browse Source
This commit is contained in:
James Cole
2023-08-08 15:03:58 +02:00
parent 7a2d4c9bd2
commit 02c906afe6
12 changed files with 412 additions and 107 deletions
Download Patch File Download Diff File Expand all files Collapse all files

208
app/Transformers/V2/TransactionGroupTransformer.php
View File

@@ -25,13 +25,19 @@ declare(strict_types=1);
namespace FireflyIII\Transformers\V2;
use Carbon\Carbon;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Models\Note;
use FireflyIII\Models\TransactionCurrency;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\Models\TransactionJournalMeta;
use FireflyIII\Models\TransactionType;
use FireflyIII\Support\Http\Api\ConvertsExchangeRates;
use FireflyIII\Support\Http\Api\ExchangeRateConverter;
use FireflyIII\Support\NullArrayObject;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Log;
use stdClass;
/**
* Class TransactionGroupTransformer
@@ -40,9 +46,12 @@ class TransactionGroupTransformer extends AbstractTransformer
{
use ConvertsExchangeRates;
private array $currencies = [];
private TransactionCurrency $default;
private array $meta;
private ExchangeRateConverter $converter;
private array $currencies = [];
private TransactionCurrency $default;
private array $meta;
private array $notes;
private array $tags;
/**
* @inheritDoc
@@ -55,15 +64,12 @@ class TransactionGroupTransformer extends AbstractTransformer
/** @var array $object */
foreach ($objects as $object) {
foreach ($object['sums'] as $sum) {
$id = $sum['currency_id'];
if (!array_key_exists($id, $currencies)) {
$currencyObject = TransactionCurrency::find($sum['currency_id']);
$currencies[$id] = $currencyObject;
}
$id = (int)$sum['currency_id'];
$currencies[$id] = $currencies[$id] ?? TransactionCurrency::find($sum['currency_id']);
}
/** @var array $transaction */
foreach ($object['transactions'] as $transaction) {
$id = $transaction['transaction_journal_id'];
$id = (int)$transaction['transaction_journal_id'];
$journals[$id] = [];
}
}
@@ -77,6 +83,28 @@ class TransactionGroupTransformer extends AbstractTransformer
$id = (int)$entry->transaction_journal_id;
$this->meta[$id][$entry->name] = $entry->data;
}
// grab all notes for all journals:
$notes = Note::whereNoteableType(TransactionJournal::class)->whereIn('noteable_id', array_keys($journals))->get();
/** @var Note $note */
foreach ($notes as $note) {
$id = (int)$note->noteable_id;
$this->notes[$id] = $note;
}
// grab all tags for all journals:
$tags = DB::table('tag_transaction_journal')
->leftJoin('tags', 'tags.id', 'tag_transaction_journal.tag_id')
->whereIn('tag_transaction_journal.transaction_journal_id', array_keys($journals))
->get(['tag_transaction_journal.transaction_journal_id', 'tags.tag']);
/** @var stdClass $tag */
foreach ($tags as $tag) {
$id = (int)$tag->transaction_journal_id;
$this->tags[$id][] = $tag->tag;
}
// create converter
$this->converter = new ExchangeRateConverter();
}
/**
@@ -92,6 +120,7 @@ class TransactionGroupTransformer extends AbstractTransformer
'created_at' => $first['created_at']->toAtomString(),
'updated_at' => $first['updated_at']->toAtomString(),
'user' => (string)$first['user_id'],
'user_group' => (string)$first['user_group_id'],
'group_title' => $group['title'] ?? null,
'transactions' => $this->transformTransactions($group['transactions'] ?? []),
'links' => [
@@ -122,108 +151,102 @@ class TransactionGroupTransformer extends AbstractTransformer
* @param array $transaction
*
* @return array
* @throws FireflyException
*/
private function transformTransaction(array $transaction): array
{
$transaction = new NullArrayObject($transaction);
$journalId = (int)$transaction['transaction_journal_id'];
$meta = new NullArrayObject($this->meta[$journalId] ?? []);
$type = $this->stringFromArray($transaction, 'transaction_type_type', TransactionType::WITHDRAWAL);
$transaction = new NullArrayObject($transaction);
$type = $this->stringFromArray($transaction, 'transaction_type_type', TransactionType::WITHDRAWAL);
$journalId = (int)$transaction['transaction_journal_id'];
$meta = new NullArrayObject($this->meta[$journalId] ?? []);
/**
* Convert and use amount:
*/
$amount = app('steam')->positive((string)($transaction['amount'] ?? '0'));
$currencyId = (int)$transaction['currency_id'];
$nativeAmount = $this->converter->convert($this->default, $this->currencies[$currencyId], $transaction['date'], $amount);
$foreignAmount = null;
$nativeForeignAmount = null;
if (null !== $transaction['foreign_amount']) {
$foreignCurrencyId = (int)$transaction['foreign_currency_id'];
$foreignAmount = app('steam')->positive($transaction['foreign_amount']);
$nativeForeignAmount = $foreignAmount;
if ($transaction['foreign_currency_id'] !== $this->default->id) {
$rate = $this->getRate($this->currencies[$transaction['foreign_currency_id']], $this->default, $transaction['date']);
$nativeForeignAmount = bcmul($foreignAmount, $rate);
}
}
$nativeAmount = $amount;
if ($transaction['currency_id'] !== $this->default->id) {
$rate = $this->getRate($this->currencies[$transaction['currency_id']], $this->default, $transaction['date']);
$nativeAmount = bcmul($amount, $rate);
$nativeForeignAmount = $this->converter->convert($this->default, $this->currencies[$foreignCurrencyId], $transaction['date'], $foreignAmount);
}
return [
'user' => (string)$transaction['user_id'],
'transaction_journal_id' => (string)$transaction['transaction_journal_id'],
'type' => strtolower($type),
'date' => $transaction['date']->toAtomString(),
'order' => $transaction['order'],
'currency_id' => (string)$transaction['currency_id'],
'currency_code' => $transaction['currency_code'],
'currency_name' => $transaction['currency_name'],
'currency_symbol' => $transaction['currency_symbol'],
'currency_decimal_places' => (int)$transaction['currency_decimal_places'],
'user' => (string)$transaction['user_id'],
'user_group' => (string)$transaction['user_group_id'],
'transaction_journal_id' => (string)$transaction['transaction_journal_id'],
'type' => strtolower($type),
'date' => $transaction['date']->toAtomString(),
'order' => $transaction['order'],
'amount' => $amount,
'native_amount' => $nativeAmount,
'foreign_amount' => $foreignAmount,
'native_foreign_amount' => $nativeForeignAmount,
'currency_id' => (string)$transaction['currency_id'],
'currency_code' => $transaction['currency_code'],
'currency_name' => $transaction['currency_name'],
'currency_symbol' => $transaction['currency_symbol'],
'currency_decimal_places' => (int)$transaction['currency_decimal_places'],
// converted to native currency
'native_currency_converted' => $transaction['currency_id'] !== $this->default->id,
'native_currency_id' => (string)$this->default->id,
'native_currency_code' => $this->default->code,
'native_currency_name' => $this->default->name,
'native_currency_symbol' => $this->default->symbol,
'native_currency_decimal_places' => (int)$this->default->decimal_places,
'native_id' => (string)$this->default->id,
'native_code' => $this->default->code,
'native_name' => $this->default->name,
'native_symbol' => $this->default->symbol,
'native_decimal_places' => (int)$this->default->decimal_places,
// foreign currency amount:
'foreign_currency_id' => $this->stringFromArray($transaction, 'foreign_currency_id', null),
'foreign_currency_code' => $transaction['foreign_currency_code'],
'foreign_currency_name' => $transaction['foreign_currency_name'],
'foreign_currency_symbol' => $transaction['foreign_currency_symbol'],
'foreign_currency_decimal_places' => $transaction['foreign_currency_decimal_places'],
// foreign converted to native currency:
'foreign_currency_converted' => null !== $transaction['foreign_currency_id'] && $transaction['foreign_currency_id'] !== $this->default->id,
'amount' => $amount,
'native_amount' => $nativeAmount,
'foreign_amount' => $foreignAmount,
'native_foreign_amount' => $nativeForeignAmount,
'description' => $transaction['description'],
'source_id' => (string)$transaction['source_account_id'],
'source_name' => $transaction['source_account_name'],
'source_iban' => $transaction['source_account_iban'],
'source_type' => $transaction['source_account_type'],
'destination_id' => (string)$transaction['destination_account_id'],
'destination_name' => $transaction['destination_account_name'],
'destination_iban' => $transaction['destination_account_iban'],
'destination_type' => $transaction['destination_account_type'],
'budget_id' => $this->stringFromArray($transaction, 'budget_id', null),
'budget_name' => $transaction['budget_name'],
'category_id' => $this->stringFromArray($transaction, 'category_id', null),
'category_name' => $transaction['category_name'],
'bill_id' => $this->stringFromArray($transaction, 'bill_id', null),
'bill_name' => $transaction['bill_name'],
'reconciled' => $transaction['reconciled'],
//'notes' => $this->groupRepos->getNoteText((int) $row['transaction_journal_id']),
//'tags' => $this->groupRepos->getTags((int) $row['transaction_journal_id']),
'internal_reference' => $meta['internal_reference'],
'external_id' => $meta['external_id'],
'original_source' => $meta['original_source'],
'recurrence_id' => $meta['recurrence_id'],
'recurrence_total' => $meta['recurrence_total'],
'recurrence_count' => $meta['recurrence_count'],
'bunq_payment_id' => $meta['bunq_payment_id'],
'external_url' => $meta['external_url'],
'import_hash_v2' => $meta['import_hash_v2'],
'sepa_cc' => $meta['sepa_cc'],
'sepa_ct_op' => $meta['sepa_ct_op'],
'sepa_ct_id' => $meta['sepa_ct_id'],
'sepa_db' => $meta['sepa_db'],
'sepa_country' => $meta['sepa_country'],
'sepa_ep' => $meta['sepa_ep'],
'sepa_ci' => $meta['sepa_ci'],
'sepa_batch_id' => $meta['sepa_batch_id'],
'interest_date' => $this->date($meta['interest_date']),
'book_date' => $this->date($meta['book_date']),
'process_date' => $this->date($meta['process_date']),
'due_date' => $this->date($meta['due_date']),
'payment_date' => $this->date($meta['payment_date']),
'invoice_date' => $this->date($meta['invoice_date']),
// foreign converted to native:
'description' => $transaction['description'],
'source_id' => (string)$transaction['source_account_id'],
'source_name' => $transaction['source_account_name'],
'source_iban' => $transaction['source_account_iban'],
'source_type' => $transaction['source_account_type'],
'destination_id' => (string)$transaction['destination_account_id'],
'destination_name' => $transaction['destination_account_name'],
'destination_iban' => $transaction['destination_account_iban'],
'destination_type' => $transaction['destination_account_type'],
'budget_id' => $this->stringFromArray($transaction, 'budget_id', null),
'budget_name' => $transaction['budget_name'],
'category_id' => $this->stringFromArray($transaction, 'category_id', null),
'category_name' => $transaction['category_name'],
'bill_id' => $this->stringFromArray($transaction, 'bill_id', null),
'bill_name' => $transaction['bill_name'],
'reconciled' => $transaction['reconciled'],
'notes' => $this->notes[$journalId] ?? null,
'tags' => $this->tags[$journalId] ?? [],
'internal_reference' => $meta['internal_reference'],
'external_id' => $meta['external_id'],
'original_source' => $meta['original_source'],
'recurrence_id' => $meta['recurrence_id'],
'recurrence_total' => $meta['recurrence_total'],
'recurrence_count' => $meta['recurrence_count'],
'bunq_payment_id' => $meta['bunq_payment_id'],
'external_url' => $meta['external_url'],
'import_hash_v2' => $meta['import_hash_v2'],
'sepa_cc' => $meta['sepa_cc'],
'sepa_ct_op' => $meta['sepa_ct_op'],
'sepa_ct_id' => $meta['sepa_ct_id'],
'sepa_db' => $meta['sepa_db'],
'sepa_country' => $meta['sepa_country'],
'sepa_ep' => $meta['sepa_ep'],
'sepa_ci' => $meta['sepa_ci'],
'sepa_batch_id' => $meta['sepa_batch_id'],
'interest_date' => $this->date($meta['interest_date']),
'book_date' => $this->date($meta['book_date']),
'process_date' => $this->date($meta['process_date']),
'due_date' => $this->date($meta['due_date']),
'payment_date' => $this->date($meta['payment_date']),
'invoice_date' => $this->date($meta['invoice_date']),
// location data
// 'longitude' => $longitude,
@@ -237,6 +260,9 @@ class TransactionGroupTransformer extends AbstractTransformer
/**
* TODO also in the old transformer.
*
* Used to extract a value from the given array, and fall back on a sensible default or NULL
* if it can't be helped.
*
* @param NullArrayObject $array
* @param string $key
* @param string|null $default