mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2024-11-23 09:26:29 -06:00
361 lines
15 KiB
PHP
361 lines
15 KiB
PHP
<?php
|
|
/**
|
|
* TransactionGroupTransformer.php
|
|
* Copyright (c) 2019 thegrumpydictator@gmail.com
|
|
*
|
|
* This file is part of Firefly III (https://github.com/firefly-iii).
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program 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 Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace FireflyIII\Transformers;
|
|
|
|
use FireflyIII\Models\Budget;
|
|
use FireflyIII\Models\Category;
|
|
use FireflyIII\Models\Transaction;
|
|
use FireflyIII\Models\TransactionGroup;
|
|
use FireflyIII\Models\TransactionJournal;
|
|
use FireflyIII\Models\TransactionType;
|
|
use FireflyIII\Repositories\TransactionGroup\TransactionGroupRepositoryInterface;
|
|
use FireflyIII\Support\NullArrayObject;
|
|
use Illuminate\Support\Collection;
|
|
|
|
/**
|
|
* Class TransactionGroupTransformer
|
|
*/
|
|
class TransactionGroupTransformer extends AbstractTransformer
|
|
{
|
|
/** @var TransactionGroupRepositoryInterface */
|
|
private $groupRepos;
|
|
/** @var array Array with meta date fields. */
|
|
private $metaDateFields;
|
|
/** @var array Array with meta fields. */
|
|
private $metaFields;
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @codeCoverageIgnore
|
|
*/
|
|
public function __construct()
|
|
{
|
|
$this->groupRepos = app(TransactionGroupRepositoryInterface::class);
|
|
$this->metaFields = [
|
|
'sepa_cc', 'sepa_ct_op', 'sepa_ct_id', 'sepa_db', 'sepa_country', 'sepa_ep',
|
|
'sepa_ci', 'sepa_batch_id', 'internal_reference', 'bunq_payment_id', 'import_hash_v2',
|
|
'recurrence_id', 'external_id', 'original_source',
|
|
];
|
|
$this->metaDateFields = ['interest_date', 'book_date', 'process_date', 'due_date', 'payment_date', 'invoice_date'];
|
|
|
|
if ('testing' === config('app.env')) {
|
|
app('log')->warning(sprintf('%s should not be instantiated in the TEST environment!', get_class($this)));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param array $group
|
|
*
|
|
* @return array
|
|
*/
|
|
public function transform(array $group): array
|
|
{
|
|
$data = new NullArrayObject($group);
|
|
$first = new NullArrayObject(reset($group['transactions']));
|
|
$result = [
|
|
'id' => (int)$first['transaction_group_id'],
|
|
'created_at' => $first['created_at']->toAtomString(),
|
|
'updated_at' => $first['updated_at']->toAtomString(),
|
|
'user' => (int)$data['user_id'],
|
|
'group_title' => $data['title'],
|
|
'transactions' => $this->transformTransactions($data),
|
|
'links' => [
|
|
[
|
|
'rel' => 'self',
|
|
'uri' => '/transactions/' . $first['transaction_group_id'],
|
|
],
|
|
],
|
|
];
|
|
|
|
// do something else.
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* @param TransactionGroup $group
|
|
*
|
|
* @return array
|
|
*/
|
|
public function transformObject(TransactionGroup $group): array
|
|
{
|
|
$result = [
|
|
'id' => (int)$group->id,
|
|
'created_at' => $group->created_at->toAtomString(),
|
|
'updated_at' => $group->updated_at->toAtomString(),
|
|
'user' => (int)$group->user_id,
|
|
'group_title' => $group->title,
|
|
'transactions' => $this->transformJournals($group->transactionJournals),
|
|
'links' => [
|
|
[
|
|
'rel' => 'self',
|
|
'uri' => '/transactions/' . $group->id,
|
|
],
|
|
],
|
|
];
|
|
|
|
// do something else.
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* @param TransactionJournal $journal
|
|
*
|
|
* @return Transaction
|
|
*/
|
|
private function getDestinationTransaction(TransactionJournal $journal): Transaction
|
|
{
|
|
|
|
return $journal->transactions->first(
|
|
static function (Transaction $transaction) {
|
|
return (float)$transaction->amount > 0;
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @param TransactionJournal $journal
|
|
*
|
|
* @return Transaction
|
|
*/
|
|
private function getSourceTransaction(TransactionJournal $journal): Transaction
|
|
{
|
|
|
|
return $journal->transactions->first(
|
|
static function (Transaction $transaction) {
|
|
return (float)$transaction->amount < 0;
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @param Collection $transactionJournals
|
|
*
|
|
* @return array
|
|
*/
|
|
private function transformJournals(Collection $transactionJournals): array
|
|
{
|
|
$result = [];
|
|
/** @var TransactionJournal $journal */
|
|
foreach ($transactionJournals as $journal) {
|
|
$source = $this->getSourceTransaction($journal);
|
|
$destination = $this->getDestinationTransaction($journal);
|
|
$type = $journal->transactionType->type;
|
|
|
|
// get amount
|
|
$amount = app('steam')->positive($source->amount);
|
|
if (TransactionType::WITHDRAWAL !== $type) {
|
|
$amount = app('steam')->negative($source->amount);
|
|
}
|
|
|
|
// get foreign amount:
|
|
$foreignAmount = null;
|
|
// @codeCoverageIgnoreStart
|
|
if (null !== $source->foreign_amount) {
|
|
$foreignAmount = TransactionType::WITHDRAWAL !== $type
|
|
? app('steam')->negative($source->foreign_amount)
|
|
: app('steam')->positive($source->foreign_amount);
|
|
}
|
|
// @codeCoverageIgnoreEnd
|
|
|
|
$metaFieldData = $this->groupRepos->getMetaFields($journal->id, $this->metaFields);
|
|
$metaDateData = $this->groupRepos->getMetaDateFields($journal->id, $this->metaDateFields);
|
|
/** @var Budget $budget */
|
|
$budget = $journal->budgets->first();
|
|
/** @var Category $category */
|
|
$category = $journal->categories->first();
|
|
$currency = $source->transactionCurrency;
|
|
$result[] = [
|
|
'user' => (int)$journal->user_id,
|
|
'transaction_journal_id' => $journal->id,
|
|
'type' => strtolower($type),
|
|
'date' => $journal->date->toAtomString(),
|
|
'order' => $journal->order,
|
|
|
|
'currency_id' => $currency->id,
|
|
'currency_code' => $currency->code,
|
|
'currency_symbol' => $currency->symbol,
|
|
'currency_decimal_places' => $currency->decimal_places,
|
|
|
|
'foreign_currency_id' => $source->foreignCurrency ? $source->foreignCurrency->id : null,
|
|
'foreign_currency_code' => $source->foreignCurrency ? $source->foreignCurrency->code : null,
|
|
'foreign_currency_symbol' => $source->foreignCurrency ? $source->foreignCurrency->symbol : null,
|
|
'foreign_currency_decimal_places' => $source->foreignCurrency ? $source->foreignCurrency->decimal_places : null,
|
|
|
|
'amount' => $amount,
|
|
'foreign_amount' => $foreignAmount,
|
|
|
|
'description' => $journal->description,
|
|
|
|
'source_id' => $source->account_id,
|
|
'source_name' => $source->account->name,
|
|
'source_iban' => $source->account->iban,
|
|
'source_type' => $source->account->accountType->type,
|
|
|
|
'destination_id' => $destination->account_id,
|
|
'destination_name' => $destination->account->name,
|
|
'destination_iban' => $destination->account->iban,
|
|
'destination_type' => $destination->account->accountType->type,
|
|
|
|
'budget_id' => $budget ? $budget->id : null,
|
|
'budget_name' => $budget ? $budget->name : null,
|
|
|
|
'category_id' => $category ? $category->id : null,
|
|
'category_name' => $category ? $category->name : null,
|
|
|
|
'bill_id' => $journal->bill_id ?: null,
|
|
'bill_name' => $journal->bill ? $journal->bill->name : null,
|
|
|
|
'reconciled' => $source->reconciled,
|
|
'notes' => $this->groupRepos->getNoteText($journal->id),
|
|
'tags' => $this->groupRepos->getTags($journal->id),
|
|
|
|
'internal_reference' => $metaFieldData['internal_reference'],
|
|
'external_id' => $metaFieldData['external_id'],
|
|
'original_source' => $metaFieldData['original_source'],
|
|
'recurrence_id' => $metaFieldData['recurrence_id'],
|
|
'bunq_payment_id' => $metaFieldData['bunq_payment_id'],
|
|
'import_hash_v2' => $metaFieldData['import_hash_v2'],
|
|
|
|
'sepa_cc' => $metaFieldData['sepa_cc'],
|
|
'sepa_ct_op' => $metaFieldData['sepa_ct_op'],
|
|
'sepa_ct_id' => $metaFieldData['sepa_ct_id'],
|
|
'sepa_db' => $metaFieldData['sepa_ddb'],
|
|
'sepa_country' => $metaFieldData['sepa_country'],
|
|
'sepa_ep' => $metaFieldData['sepa_ep'],
|
|
'sepa_ci' => $metaFieldData['sepa_ci'],
|
|
'sepa_batch_id' => $metaFieldData['sepa_batch_id'],
|
|
|
|
'interest_date' => $metaDateData['interest_date'] ? $metaDateData['interest_date']->toAtomString() : null,
|
|
'book_date' => $metaDateData['book_date'] ? $metaDateData['book_date']->toAtomString() : null,
|
|
'process_date' => $metaDateData['process_date'] ? $metaDateData['process_date']->toAtomString() : null,
|
|
'due_date' => $metaDateData['due_date'] ? $metaDateData['due_date']->toAtomString() : null,
|
|
'payment_date' => $metaDateData['payment_date'] ? $metaDateData['payment_date']->toAtomString() : null,
|
|
'invoice_date' => $metaDateData['invoice_date'] ? $metaDateData['invoice_date']->toAtomString() : null,
|
|
];
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* @param NullArrayObject $data
|
|
*
|
|
* @return array
|
|
*/
|
|
private function transformTransactions(NullArrayObject $data): array
|
|
{
|
|
$result = [];
|
|
$transactions = $data['transactions'] ?? [];
|
|
foreach ($transactions as $transaction) {
|
|
$row = new NullArrayObject($transaction);
|
|
|
|
// amount:
|
|
$type = $row['transaction_type_type'] ?? TransactionType::WITHDRAWAL;
|
|
$amount = app('steam')->positive($row['amount'] ?? '0');
|
|
$foreignAmount = null;
|
|
if (null !== $row['foreign_amount']) {
|
|
$foreignAmount = app('steam')->positive($row['foreign_amount']);
|
|
}
|
|
|
|
$metaFieldData = $this->groupRepos->getMetaFields((int)$row['transaction_journal_id'], $this->metaFields);
|
|
$metaDateData = $this->groupRepos->getMetaDateFields((int)$row['transaction_journal_id'], $this->metaDateFields);
|
|
|
|
$result[] = [
|
|
'user' => (int)$row['user_id'],
|
|
'transaction_journal_id' => $row['transaction_journal_id'],
|
|
'type' => strtolower($type),
|
|
'date' => $row['date']->toAtomString(),
|
|
'order' => $row['order'],
|
|
|
|
'currency_id' => $row['currency_id'],
|
|
'currency_code' => $row['currency_code'],
|
|
'currency_name' => $row['currency_name'],
|
|
'currency_symbol' => $row['currency_symbol'],
|
|
'currency_decimal_places' => $row['currency_decimal_places'],
|
|
|
|
'foreign_currency_id' => $row['foreign_currency_id'],
|
|
'foreign_currency_code' => $row['foreign_currency_code'],
|
|
'foreign_currency_symbol' => $row['foreign_currency_symbol'],
|
|
'foreign_currency_decimal_places' => $row['foreign_currency_decimal_places'],
|
|
|
|
'amount' => $amount,
|
|
'foreign_amount' => $foreignAmount,
|
|
|
|
'description' => $row['description'],
|
|
|
|
'source_id' => $row['source_account_id'],
|
|
'source_name' => $row['source_account_name'],
|
|
'source_iban' => $row['source_account_iban'],
|
|
'source_type' => $row['source_account_type'],
|
|
|
|
'destination_id' => $row['destination_account_id'],
|
|
'destination_name' => $row['destination_account_name'],
|
|
'destination_iban' => $row['destination_account_iban'],
|
|
'destination_type' => $row['destination_account_type'],
|
|
|
|
'budget_id' => $row['budget_id'],
|
|
'budget_name' => $row['budget_name'],
|
|
|
|
'category_id' => $row['category_id'],
|
|
'category_name' => $row['category_name'],
|
|
|
|
'bill_id' => $row['bill_id'],
|
|
'bill_name' => $row['bill_name'],
|
|
|
|
'reconciled' => $row['reconciled'],
|
|
'notes' => $this->groupRepos->getNoteText((int)$row['transaction_journal_id']),
|
|
'tags' => $this->groupRepos->getTags((int)$row['transaction_journal_id']),
|
|
|
|
'internal_reference' => $metaFieldData['internal_reference'],
|
|
'external_id' => $metaFieldData['external_id'],
|
|
'original_source' => $metaFieldData['original_source'],
|
|
'recurrence_id' => $metaFieldData['recurrence_id'],
|
|
'bunq_payment_id' => $metaFieldData['bunq_payment_id'],
|
|
'import_hash_v2' => $metaFieldData['import_hash_v2'],
|
|
|
|
'sepa_cc' => $metaFieldData['sepa_cc'],
|
|
'sepa_ct_op' => $metaFieldData['sepa_ct_op'],
|
|
'sepa_ct_id' => $metaFieldData['sepa_ct_id'],
|
|
'sepa_db' => $metaFieldData['sepa_ddb'],
|
|
'sepa_country' => $metaFieldData['sepa_country'],
|
|
'sepa_ep' => $metaFieldData['sepa_ep'],
|
|
'sepa_ci' => $metaFieldData['sepa_ci'],
|
|
'sepa_batch_id' => $metaFieldData['sepa_batch_id'],
|
|
|
|
'interest_date' => $metaDateData['interest_date'] ? $metaDateData['interest_date']->toAtomString() : null,
|
|
'book_date' => $metaDateData['book_date'] ? $metaDateData['book_date']->toAtomString() : null,
|
|
'process_date' => $metaDateData['process_date'] ? $metaDateData['process_date']->toAtomString() : null,
|
|
'due_date' => $metaDateData['due_date'] ? $metaDateData['due_date']->toAtomString() : null,
|
|
'payment_date' => $metaDateData['payment_date'] ? $metaDateData['payment_date']->toAtomString() : null,
|
|
'invoice_date' => $metaDateData['invoice_date'] ? $metaDateData['invoice_date']->toAtomString() : null,
|
|
];
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
}
|