2018-02-16 09:43:25 -06:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* TransactionFactory.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/>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
declare(strict_types=1);
|
|
|
|
|
|
|
|
namespace FireflyIII\Factory;
|
|
|
|
|
|
|
|
|
|
|
|
use FireflyIII\Models\Transaction;
|
|
|
|
use FireflyIII\Models\TransactionJournal;
|
2018-02-23 08:12:47 -06:00
|
|
|
use FireflyIII\Services\Internal\Support\TransactionServiceTrait;
|
2018-02-16 09:43:25 -06:00
|
|
|
use FireflyIII\User;
|
|
|
|
use Illuminate\Support\Collection;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Class TransactionFactory
|
|
|
|
*/
|
|
|
|
class TransactionFactory
|
|
|
|
{
|
2018-02-23 08:12:47 -06:00
|
|
|
use TransactionServiceTrait;
|
|
|
|
|
2018-02-16 09:43:25 -06:00
|
|
|
/** @var User */
|
|
|
|
private $user;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param array $data
|
|
|
|
*
|
|
|
|
* @return Transaction
|
|
|
|
*/
|
|
|
|
public function create(array $data): Transaction
|
|
|
|
{
|
2018-02-21 13:34:24 -06:00
|
|
|
$currencyId = isset($data['currency']) ? $data['currency']->id : $data['currency_id'];
|
|
|
|
|
2018-02-19 12:44:46 -06:00
|
|
|
return Transaction::create(
|
|
|
|
[
|
|
|
|
'reconciled' => $data['reconciled'],
|
|
|
|
'account_id' => $data['account']->id,
|
|
|
|
'transaction_journal_id' => $data['transaction_journal']->id,
|
|
|
|
'description' => $data['description'],
|
2018-02-21 13:34:24 -06:00
|
|
|
'transaction_currency_id' => $currencyId,
|
2018-02-19 12:44:46 -06:00
|
|
|
'amount' => $data['amount'],
|
|
|
|
'foreign_amount' => $data['foreign_amount'],
|
|
|
|
'foreign_currency_id' => null,
|
|
|
|
'identifier' => $data['identifier'],
|
|
|
|
]
|
|
|
|
);
|
2018-02-16 09:43:25 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Create a pair of transactions based on the data given in the array.
|
|
|
|
*
|
|
|
|
* @param TransactionJournal $journal
|
|
|
|
* @param array $data
|
|
|
|
*
|
|
|
|
* @return Collection
|
|
|
|
*/
|
|
|
|
public function createPair(TransactionJournal $journal, array $data): Collection
|
|
|
|
{
|
|
|
|
// all this data is the same for both transactions:
|
2018-02-18 09:35:26 -06:00
|
|
|
$currency = $this->findCurrency($data['currency_id'], $data['currency_code']);
|
|
|
|
$description = $journal->description === $data['description'] ? null : $data['description'];
|
2018-02-16 09:43:25 -06:00
|
|
|
|
|
|
|
// type of source account depends on journal type:
|
|
|
|
$sourceType = $this->accountType($journal, 'source');
|
2018-02-18 03:31:15 -06:00
|
|
|
$sourceAccount = $this->findAccount($sourceType, $data['source_id'], $data['source_name']);
|
2018-02-16 09:43:25 -06:00
|
|
|
|
|
|
|
// same for destination account:
|
|
|
|
$destinationType = $this->accountType($journal, 'destination');
|
2018-02-18 03:31:15 -06:00
|
|
|
$destinationAccount = $this->findAccount($destinationType, $data['destination_id'], $data['destination_name']);
|
2018-02-16 09:43:25 -06:00
|
|
|
// first make a "negative" (source) transaction based on the data in the array.
|
2018-02-18 09:35:26 -06:00
|
|
|
$source = $this->create(
|
|
|
|
[
|
|
|
|
'description' => $description,
|
|
|
|
'amount' => app('steam')->negative(strval($data['amount'])),
|
|
|
|
'foreign_amount' => null,
|
|
|
|
'currency' => $currency,
|
|
|
|
'account' => $sourceAccount,
|
|
|
|
'transaction_journal' => $journal,
|
|
|
|
'reconciled' => $data['reconciled'],
|
|
|
|
'identifier' => $data['identifier'],
|
|
|
|
]
|
|
|
|
);
|
2018-02-16 09:43:25 -06:00
|
|
|
// then make a "positive" transaction based on the data in the array.
|
2018-02-18 09:35:26 -06:00
|
|
|
$dest = $this->create(
|
|
|
|
[
|
|
|
|
'description' => $description,
|
|
|
|
'amount' => app('steam')->positive(strval($data['amount'])),
|
|
|
|
'foreign_amount' => null,
|
|
|
|
'currency' => $currency,
|
|
|
|
'account' => $destinationAccount,
|
|
|
|
'transaction_journal' => $journal,
|
|
|
|
'reconciled' => $data['reconciled'],
|
|
|
|
'identifier' => $data['identifier'],
|
|
|
|
]
|
|
|
|
);
|
2018-02-19 12:44:46 -06:00
|
|
|
|
2018-02-18 09:35:26 -06:00
|
|
|
// set foreign currency
|
|
|
|
$foreign = $this->findCurrency($data['foreign_currency_id'], $data['foreign_currency_code']);
|
|
|
|
$this->setForeignCurrency($source, $foreign);
|
|
|
|
$this->setForeignCurrency($dest, $foreign);
|
|
|
|
|
|
|
|
// set foreign amount:
|
|
|
|
if (!is_null($data['foreign_amount'])) {
|
|
|
|
$this->setForeignAmount($source, app('steam')->negative(strval($data['foreign_amount'])));
|
|
|
|
$this->setForeignAmount($dest, app('steam')->positive(strval($data['foreign_amount'])));
|
|
|
|
}
|
|
|
|
|
|
|
|
// set budget:
|
|
|
|
$budget = $this->findBudget($data['budget_id'], $data['budget_name']);
|
|
|
|
$this->setBudget($source, $budget);
|
|
|
|
$this->setBudget($dest, $budget);
|
|
|
|
|
|
|
|
// set category
|
|
|
|
$category = $this->findCategory($data['category_id'], $data['category_name']);
|
|
|
|
$this->setCategory($source, $category);
|
|
|
|
$this->setCategory($dest, $category);
|
2018-02-16 09:57:46 -06:00
|
|
|
|
|
|
|
return new Collection([$source, $dest]);
|
2018-02-16 09:43:25 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param User $user
|
|
|
|
*/
|
|
|
|
public function setUser(User $user)
|
|
|
|
{
|
|
|
|
$this->user = $user;
|
|
|
|
}
|
2018-02-18 09:35:26 -06:00
|
|
|
|
|
|
|
|
2018-02-16 09:43:25 -06:00
|
|
|
}
|