2018-02-16 09:43:25 -06:00
|
|
|
<?php
|
2018-05-11 03:08:34 -05:00
|
|
|
|
2018-02-16 09:43:25 -06:00
|
|
|
/**
|
|
|
|
|
* TransactionJournalFactory.php
|
|
|
|
|
* Copyright (c) 2018 thegrumpydictator@gmail.com
|
|
|
|
|
*
|
|
|
|
|
* This file is part of Firefly III.
|
|
|
|
|
*
|
|
|
|
|
* Firefly III is free software: you can redistribute it and/or modify
|
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
|
|
|
* (at your option) any later version.
|
|
|
|
|
*
|
|
|
|
|
* Firefly III 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 General Public License for more details.
|
|
|
|
|
*
|
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
|
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
*/
|
|
|
|
|
|
2018-05-11 03:08:34 -05:00
|
|
|
declare(strict_types=1);
|
2018-02-16 09:43:25 -06:00
|
|
|
|
|
|
|
|
namespace FireflyIII\Factory;
|
|
|
|
|
|
2019-03-07 22:47:51 -06:00
|
|
|
use Carbon\Carbon;
|
|
|
|
|
use Exception;
|
2018-02-16 09:43:25 -06:00
|
|
|
use FireflyIII\Models\TransactionJournal;
|
2019-03-07 22:47:51 -06:00
|
|
|
use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface;
|
|
|
|
|
use FireflyIII\Repositories\TransactionType\TransactionTypeRepositoryInterface;
|
2018-02-16 09:43:25 -06:00
|
|
|
use FireflyIII\User;
|
2019-03-05 10:26:49 -06:00
|
|
|
use Illuminate\Support\Collection;
|
2018-02-23 08:12:47 -06:00
|
|
|
use Log;
|
2018-02-16 09:43:25 -06:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Class TransactionJournalFactory
|
|
|
|
|
*/
|
|
|
|
|
class TransactionJournalFactory
|
|
|
|
|
{
|
2019-03-07 22:47:51 -06:00
|
|
|
/** @var CurrencyRepositoryInterface */
|
|
|
|
|
private $currencyRepository;
|
|
|
|
|
|
|
|
|
|
/** @var TransactionFactory */
|
|
|
|
|
private $transactionFactory;
|
|
|
|
|
|
|
|
|
|
/** @var TransactionTypeRepositoryInterface */
|
|
|
|
|
private $typeRepository;
|
|
|
|
|
|
|
|
|
|
// private $fields;
|
2018-09-22 23:53:15 -05:00
|
|
|
/** @var User The user */
|
|
|
|
|
private $user;
|
|
|
|
|
|
2019-03-07 22:47:51 -06:00
|
|
|
//
|
|
|
|
|
// use JournalServiceTrait, TransactionTypeTrait;
|
2018-09-22 23:53:15 -05:00
|
|
|
|
2018-09-06 05:29:32 -05:00
|
|
|
/**
|
|
|
|
|
* Constructor.
|
|
|
|
|
*/
|
|
|
|
|
public function __construct()
|
|
|
|
|
{
|
2019-03-07 22:47:51 -06:00
|
|
|
// $this->fields = ['sepa-cc', 'sepa-ct-op', 'sepa-ct-id', 'sepa-db', 'sepa-country', 'sepa-ep', 'sepa-ci', 'interest_date', 'book_date', 'process_date',
|
|
|
|
|
// 'due_date', 'recurrence_id', 'payment_date', 'invoice_date', 'internal_reference', 'bunq_payment_id', 'importHash', 'importHashV2',
|
|
|
|
|
// 'external_id', 'sepa-batch-id', 'original-source'];
|
2018-12-15 00:59:02 -06:00
|
|
|
if ('testing' === config('app.env')) {
|
2018-09-06 05:29:32 -05:00
|
|
|
Log::warning(sprintf('%s should not be instantiated in the TEST environment!', \get_class($this)));
|
|
|
|
|
}
|
2019-03-07 22:47:51 -06:00
|
|
|
$this->currencyRepository = app(CurrencyRepositoryInterface::class);
|
|
|
|
|
$this->typeRepository = app(TransactionTypeRepositoryInterface::class);
|
|
|
|
|
$this->transactionFactory = app(TransactionFactory::class);
|
2018-09-06 05:29:32 -05:00
|
|
|
}
|
|
|
|
|
|
2018-02-16 09:43:25 -06:00
|
|
|
/**
|
2018-07-06 12:06:08 -05:00
|
|
|
* Store a new transaction journal.
|
|
|
|
|
*
|
2018-02-16 09:43:25 -06:00
|
|
|
* @param array $data
|
|
|
|
|
*
|
2019-03-05 10:26:49 -06:00
|
|
|
* @return Collection
|
2019-03-07 22:47:51 -06:00
|
|
|
* @throws Exception
|
2018-02-16 09:43:25 -06:00
|
|
|
*/
|
2019-03-05 10:26:49 -06:00
|
|
|
public function create(array $data): Collection
|
2018-02-16 09:43:25 -06:00
|
|
|
{
|
2018-02-23 08:12:47 -06:00
|
|
|
Log::debug('Start of TransactionJournalFactory::create()');
|
2019-03-07 22:47:51 -06:00
|
|
|
$collection = new Collection;
|
|
|
|
|
$transactions = $data['transactions'] ?? [];
|
|
|
|
|
$type = $this->typeRepository->findTransactionType(null, $data['type']);
|
|
|
|
|
$description = app('steam')->cleanString($data['description']);
|
|
|
|
|
$carbon = $data['date'] ?? new Carbon;
|
2019-03-05 10:26:49 -06:00
|
|
|
$carbon->setTimezone(config('app.timezone'));
|
2018-02-18 03:31:15 -06:00
|
|
|
|
2019-03-07 22:47:51 -06:00
|
|
|
/** @var array $transaction */
|
|
|
|
|
foreach ($transactions as $transaction) {
|
2018-02-18 09:35:26 -06:00
|
|
|
|
2019-03-07 22:47:51 -06:00
|
|
|
/** Get basic fields */
|
|
|
|
|
$currency = $this->currencyRepository->findCurrency($transaction['currency'], $transaction['currency_id'], $transaction['currency_code']);
|
2018-02-18 09:35:26 -06:00
|
|
|
|
2019-03-07 22:47:51 -06:00
|
|
|
/** Create a basic journal. */
|
2019-03-05 10:26:49 -06:00
|
|
|
$journal = TransactionJournal::create(
|
|
|
|
|
[
|
2019-03-07 22:47:51 -06:00
|
|
|
'user_id' => $this->user->id,
|
2019-03-05 10:26:49 -06:00
|
|
|
'transaction_type_id' => $type->id,
|
|
|
|
|
'bill_id' => null,
|
2019-03-07 22:47:51 -06:00
|
|
|
'transaction_currency_id' => $currency->id,
|
2019-03-05 10:26:49 -06:00
|
|
|
'description' => $description,
|
|
|
|
|
'date' => $carbon->format('Y-m-d H:i:s'),
|
|
|
|
|
'order' => 0,
|
|
|
|
|
'tag_count' => 0,
|
|
|
|
|
'completed' => 0,
|
|
|
|
|
]
|
|
|
|
|
);
|
2018-02-18 09:35:26 -06:00
|
|
|
|
2019-03-07 22:47:51 -06:00
|
|
|
/** Create two transactions. */
|
|
|
|
|
$this->transactionFactory->setJournal($journal);
|
|
|
|
|
$children = $this->transactionFactory->createPair($currency, $transaction);
|
2018-03-24 08:05:29 -05:00
|
|
|
|
2019-03-05 10:26:49 -06:00
|
|
|
|
|
|
|
|
|
2018-03-01 13:54:50 -06:00
|
|
|
|
2019-03-07 22:47:51 -06:00
|
|
|
$collection->push($journal);
|
|
|
|
|
Log::debug(sprintf('Created journal #%d', $journal->id));
|
2019-03-05 10:26:49 -06:00
|
|
|
|
2019-03-07 22:47:51 -06:00
|
|
|
return $collection;
|
2019-03-05 10:26:49 -06:00
|
|
|
|
|
|
|
|
|
2019-03-07 22:47:51 -06:00
|
|
|
/** Create two basic transactions */
|
|
|
|
|
}
|
2018-06-20 09:09:15 -05:00
|
|
|
|
2019-03-07 22:47:51 -06:00
|
|
|
|
|
|
|
|
// /** @var TransactionFactory $factory */
|
|
|
|
|
// $factory = app(TransactionFactory::class);
|
|
|
|
|
// $journals = new Collection;
|
|
|
|
|
// ;
|
|
|
|
|
// $type = $this->findTransactionType($data['type']);
|
|
|
|
|
//
|
|
|
|
|
//
|
|
|
|
|
//
|
|
|
|
|
// $factory->setUser($this->user);
|
|
|
|
|
//
|
|
|
|
|
// Log::debug(sprintf('New journal(group): %s with description "%s"', $type->type, $description));
|
|
|
|
|
//
|
|
|
|
|
// // loop each transaction.
|
|
|
|
|
// /**
|
|
|
|
|
// * @var int $index
|
|
|
|
|
// * @var array $transactionData
|
|
|
|
|
// */
|
|
|
|
|
// foreach ($data['transactions'] as $index => $transactionData) {
|
|
|
|
|
// Log::debug(sprintf('Now at journal #%d from %d', $index + 1, count($data['transactions'])));
|
|
|
|
|
//
|
|
|
|
|
// // catch to stop empty amounts:
|
|
|
|
|
// if ('' === (string)$transactionData['amount'] || 0.0 === (float)$transactionData['amount']) {
|
|
|
|
|
// continue;
|
|
|
|
|
// }
|
|
|
|
|
// // currency & foreign currency
|
|
|
|
|
// $transactionData['currency'] = $this->getCurrency($transactionData, $index);
|
|
|
|
|
// $transactionData['foreign_currency'] = $this->getForeignCurrency($transactionData, $index);
|
|
|
|
|
//
|
|
|
|
|
// // store basic journal first.
|
|
|
|
|
// $journal = TransactionJournal::create(
|
|
|
|
|
// [
|
|
|
|
|
// 'user_id' => $data['user'],
|
|
|
|
|
// 'transaction_type_id' => $type->id,
|
|
|
|
|
// 'bill_id' => null,
|
|
|
|
|
// 'transaction_currency_id' => $transactionData['currency']->id,
|
|
|
|
|
// 'description' => $description,
|
|
|
|
|
// 'date' => $carbon->format('Y-m-d H:i:s'),
|
|
|
|
|
// 'order' => 0,
|
|
|
|
|
// 'tag_count' => 0,
|
|
|
|
|
// 'completed' => 0,
|
|
|
|
|
// ]
|
|
|
|
|
// );
|
|
|
|
|
// Log::debug(sprintf('Stored journal under ID #%d', $journal->id));
|
|
|
|
|
//
|
|
|
|
|
// // store transactions for this journal:
|
|
|
|
|
// $factory->createPair($journal, $transactionData);
|
|
|
|
|
//
|
|
|
|
|
// // link bill
|
|
|
|
|
// Log::debug('Connect bill');
|
|
|
|
|
// $this->connectBill($journal, $transactionData);
|
|
|
|
|
//
|
|
|
|
|
// // link piggy bank (if transfer)
|
|
|
|
|
// $this->connectPiggyBank($journal, $transactionData);
|
|
|
|
|
//
|
|
|
|
|
// // link tags
|
|
|
|
|
// $this->connectTags($journal, $transactionData);
|
|
|
|
|
//
|
|
|
|
|
// // store note
|
|
|
|
|
// $this->storeNote($journal, $transactionData['notes']);
|
|
|
|
|
//
|
|
|
|
|
// // save journal:
|
|
|
|
|
// $journal->completed = true;
|
|
|
|
|
// $journal->save();
|
|
|
|
|
//
|
|
|
|
|
//
|
|
|
|
|
//
|
|
|
|
|
// // if ($journal->transactionType->type !== TransactionType::WITHDRAWAL) {
|
|
|
|
|
// // $transactionData['budget_id'] = null;
|
|
|
|
|
// // $transactionData['budget_name'] = null;
|
|
|
|
|
// // }
|
|
|
|
|
// // // save budget TODO
|
|
|
|
|
// // $budget = $this->findBudget($data['budget_id'], $data['budget_name']);
|
|
|
|
|
// // $this->setBudget($journal, $budget);
|
|
|
|
|
// //
|
|
|
|
|
// // // set category TODO
|
|
|
|
|
// // $category = $this->findCategory($data['category_id'], $data['category_name']);
|
|
|
|
|
// // $this->setCategory($journal, $category);
|
|
|
|
|
// //
|
|
|
|
|
// // // store meta data TODO
|
|
|
|
|
// // foreach ($this->fields as $field) {
|
|
|
|
|
// // $this->storeMeta($journal, $data, $field);
|
|
|
|
|
// // }
|
|
|
|
|
//
|
|
|
|
|
// // add to array
|
|
|
|
|
// $journals->push($journal);
|
|
|
|
|
// }
|
|
|
|
|
//
|
|
|
|
|
// // create group if necessary
|
|
|
|
|
// if ($journals->count() > 1) {
|
|
|
|
|
// $group = new TransactionGroup;
|
|
|
|
|
// $group->user()->associate($this->user);
|
|
|
|
|
// $group->title = $description;
|
|
|
|
|
// $group->save();
|
|
|
|
|
// $group->transactionJournals()->saveMany($journals);
|
|
|
|
|
//
|
|
|
|
|
// Log::debug(sprintf('More than one journal, created group #%d.', $group->id));
|
|
|
|
|
// }
|
|
|
|
|
//
|
|
|
|
|
//
|
|
|
|
|
// Log::debug('End of TransactionJournalFactory::create()');
|
|
|
|
|
// // invalidate cache.
|
|
|
|
|
// app('preferences')->mark();
|
|
|
|
|
//
|
|
|
|
|
// return $journals;
|
2018-02-16 09:43:25 -06:00
|
|
|
}
|
|
|
|
|
|
2019-03-05 10:26:49 -06:00
|
|
|
|
2018-02-16 09:43:25 -06:00
|
|
|
/**
|
|
|
|
|
* Set the user.
|
|
|
|
|
*
|
|
|
|
|
* @param User $user
|
|
|
|
|
*/
|
|
|
|
|
public function setUser(User $user): void
|
|
|
|
|
{
|
|
|
|
|
$this->user = $user;
|
2019-03-07 22:47:51 -06:00
|
|
|
$this->currencyRepository->setUser($this->user);
|
|
|
|
|
$this->transactionFactory->setUser($this->user);
|
2018-02-16 09:43:25 -06:00
|
|
|
}
|
|
|
|
|
|
2019-03-07 22:47:51 -06:00
|
|
|
// /**
|
|
|
|
|
// * Connect bill if present.
|
|
|
|
|
// *
|
|
|
|
|
// * @param TransactionJournal $journal
|
|
|
|
|
// * @param array $data
|
|
|
|
|
// */
|
|
|
|
|
// protected function connectBill(TransactionJournal $journal, array $data): void
|
|
|
|
|
// {
|
|
|
|
|
// if (!$journal->isWithdrawal()) {
|
|
|
|
|
// Log::debug(sprintf('Journal #%d is not a withdrawal', $journal->id));
|
|
|
|
|
//
|
|
|
|
|
// return;
|
|
|
|
|
// }
|
|
|
|
|
// /** @var BillFactory $factory */
|
|
|
|
|
// $factory = app(BillFactory::class);
|
|
|
|
|
// $factory->setUser($journal->user);
|
|
|
|
|
//
|
|
|
|
|
// $bill = null;
|
|
|
|
|
//
|
|
|
|
|
// if (isset($data['bill']) && $data['bill'] instanceof Bill && $data['bill']->user_id === $this->user->id) {
|
|
|
|
|
// Log::debug('Bill object found and belongs to user');
|
|
|
|
|
// $bill = $data['bill'];
|
|
|
|
|
// }
|
|
|
|
|
// if (null === $data['bill']) {
|
|
|
|
|
// Log::debug('Bill object not found, search by bill data.');
|
|
|
|
|
// $bill = $factory->find((int)$data['bill_id'], $data['bill_name']);
|
|
|
|
|
// }
|
|
|
|
|
//
|
|
|
|
|
// if (null !== $bill) {
|
|
|
|
|
// Log::debug(sprintf('Connected bill #%d (%s) to journal #%d', $bill->id, $bill->name, $journal->id));
|
|
|
|
|
// $journal->bill_id = $bill->id;
|
|
|
|
|
// $journal->save();
|
|
|
|
|
//
|
|
|
|
|
// return;
|
|
|
|
|
// }
|
|
|
|
|
// Log::debug('Bill data is NULL.');
|
|
|
|
|
// $journal->bill_id = null;
|
|
|
|
|
// $journal->save();
|
|
|
|
|
//
|
|
|
|
|
// }
|
|
|
|
|
//
|
|
|
|
|
// /**
|
|
|
|
|
// * Link a piggy bank to this journal.
|
|
|
|
|
// *
|
|
|
|
|
// * @param TransactionJournal $journal
|
|
|
|
|
// * @param array $data
|
|
|
|
|
// */
|
|
|
|
|
// protected function connectPiggyBank(TransactionJournal $journal, array $data): void
|
|
|
|
|
// {
|
|
|
|
|
// if (!$journal->isTransfer()) {
|
|
|
|
|
//
|
|
|
|
|
// return;
|
|
|
|
|
// }
|
|
|
|
|
// /** @var PiggyBankFactory $factory */
|
|
|
|
|
// $factory = app(PiggyBankFactory::class);
|
|
|
|
|
// $factory->setUser($this->user);
|
|
|
|
|
// $piggyBank = null;
|
|
|
|
|
//
|
|
|
|
|
// if (isset($data['piggy_bank']) && $data['piggy_bank'] instanceof PiggyBank && $data['piggy_bank']->account->user_id === $this->user->id) {
|
|
|
|
|
// Log::debug('Piggy found and belongs to user');
|
|
|
|
|
// $piggyBank = $data['piggy_bank'];
|
|
|
|
|
// }
|
|
|
|
|
// if (null === $data['piggy_bank']) {
|
|
|
|
|
// Log::debug('Piggy not found, search by piggy data.');
|
|
|
|
|
// $piggyBank = $factory->find($data['piggy_bank_id'], $data['piggy_bank_name']);
|
|
|
|
|
// }
|
|
|
|
|
//
|
|
|
|
|
// if (null !== $piggyBank) {
|
|
|
|
|
// /** @var PiggyBankEventFactory $factory */
|
|
|
|
|
// $factory = app(PiggyBankEventFactory::class);
|
|
|
|
|
// $factory->create($journal, $piggyBank);
|
|
|
|
|
// Log::debug('Create piggy event.');
|
|
|
|
|
//
|
|
|
|
|
// return;
|
|
|
|
|
// }
|
|
|
|
|
// Log::debug('Create no piggy event');
|
|
|
|
|
// }
|
|
|
|
|
//
|
|
|
|
|
// /**
|
|
|
|
|
// * @param array $data
|
|
|
|
|
// * @param int $index
|
|
|
|
|
// *
|
|
|
|
|
// * @return TransactionCurrency
|
|
|
|
|
// */
|
|
|
|
|
// private function getCurrency(array $data, int $index): TransactionCurrency
|
|
|
|
|
// {
|
|
|
|
|
// $currency = null;
|
|
|
|
|
// // check currency object:
|
|
|
|
|
// if (null === $currency && isset($data['currency']) && $data['currency'] instanceof TransactionCurrency) {
|
|
|
|
|
// $currency = $data['currency'];
|
|
|
|
|
// }
|
|
|
|
|
//
|
|
|
|
|
// // check currency ID:
|
|
|
|
|
// if (null === $currency && isset($data['currency_id']) && (int)$data['currency_id'] > 0) {
|
|
|
|
|
// $currencyId = (int)$data['currency_id'];
|
|
|
|
|
// $currency = TransactionCurrency::find($currencyId);
|
|
|
|
|
// }
|
|
|
|
|
//
|
|
|
|
|
// // check currency code
|
|
|
|
|
// if (null === $currency && isset($data['currency_code']) && 3 === \strlen($data['currency_code'])) {
|
|
|
|
|
// $currency = TransactionCurrency::whereCode($data['currency_code'])->first();
|
|
|
|
|
// }
|
|
|
|
|
// if (null === $currency) {
|
|
|
|
|
// // return user's default currency:
|
|
|
|
|
// $currency = app('amount')->getDefaultCurrencyByUser($this->user);
|
|
|
|
|
// }
|
|
|
|
|
//
|
|
|
|
|
// // enable currency:
|
|
|
|
|
// if (false === $currency->enabled) {
|
|
|
|
|
// $currency->enabled = true;
|
|
|
|
|
// $currency->save();
|
|
|
|
|
// }
|
|
|
|
|
// Log::debug(sprintf('Journal currency will be #%d (%s)', $currency->id, $currency->code));
|
|
|
|
|
//
|
|
|
|
|
// return $currency;
|
|
|
|
|
//
|
|
|
|
|
// }
|
|
|
|
|
//
|
|
|
|
|
// /**
|
|
|
|
|
// * @param array $data
|
|
|
|
|
// * @param int $index
|
|
|
|
|
// *
|
|
|
|
|
// * @return TransactionCurrency|null
|
|
|
|
|
// */
|
|
|
|
|
// private function getForeignCurrency(array $data, int $index): ?TransactionCurrency
|
|
|
|
|
// {
|
|
|
|
|
// $currency = null;
|
|
|
|
|
//
|
|
|
|
|
// // check currency object:
|
|
|
|
|
// if (null === $currency && isset($data['foreign_currency']) && $data['foreign_currency'] instanceof TransactionCurrency) {
|
|
|
|
|
// $currency = $data['foreign_currency'];
|
|
|
|
|
// }
|
|
|
|
|
//
|
|
|
|
|
// // check currency ID:
|
|
|
|
|
// if (null === $currency && isset($data['foreign_currency_id']) && (int)$data['foreign_currency_id'] > 0) {
|
|
|
|
|
// $currencyId = (int)$data['foreign_currency_id'];
|
|
|
|
|
// $currency = TransactionCurrency::find($currencyId);
|
|
|
|
|
// }
|
|
|
|
|
//
|
|
|
|
|
// // check currency code
|
|
|
|
|
// if (null === $currency && isset($data['foreign_currency_code']) && 3 === \strlen($data['foreign_currency_code'])) {
|
|
|
|
|
// $currency = TransactionCurrency::whereCode($data['foreign_currency_code'])->first();
|
|
|
|
|
// }
|
|
|
|
|
//
|
|
|
|
|
// // enable currency:
|
|
|
|
|
// if (null !== $currency && false === $currency->enabled) {
|
|
|
|
|
// $currency->enabled = true;
|
|
|
|
|
// $currency->save();
|
|
|
|
|
// }
|
|
|
|
|
// if (null !== $currency) {
|
|
|
|
|
// Log::debug(sprintf('Journal foreign currency will be #%d (%s)', $currency->id, $currency->code));
|
|
|
|
|
// }
|
|
|
|
|
// if (null === $currency) {
|
|
|
|
|
// Log::debug('Journal foreign currency will be NULL');
|
|
|
|
|
// }
|
|
|
|
|
//
|
|
|
|
|
// return $currency;
|
|
|
|
|
// }
|
2019-03-05 10:26:49 -06:00
|
|
|
|
2018-03-05 12:35:58 -06:00
|
|
|
}
|
