kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-11-03 04:41:41 +00:00
Code Issues Projects Releases Wiki Activity

Code clean up.

Browse Source
This commit is contained in:
James Cole
2017-11-15 12:25:49 +01:00
parent 57dcdfa0c4
commit ffca858b8d
476 changed files with 2055 additions and 4181 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
app/Import/Storage/ImportStorage.php
View File

@@ -18,7 +18,6 @@
* 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\Import\Storage;
@@ -35,21 +34,19 @@ use Log;
/**
* Is capable of storing individual ImportJournal objects.
* Class ImportStorage
*
* @package FireflyIII\Import\Storage
* Class ImportStorage.
*/
class ImportStorage
{
use ImportSupport;
/** @var Collection */
/** @var Collection */
public $errors;
/** @var Collection */
public $journals;
/** @var int */
/** @var int */
protected $defaultCurrencyId = 1; // yes, hard coded
/** @var ImportJob */
/** @var ImportJob */
protected $job;
/** @var Collection */
protected $rules;
@@ -57,7 +54,7 @@ class ImportStorage
private $dateFormat = 'Ymd';
/** @var Collection */
private $objects;
/** @var array */
/** @var array */
private $transfers = [];
/**
@@ -125,6 +122,7 @@ class ImportStorage
* @param ImportJournal $importJournal
*
* @return bool
*
* @throws FireflyException
*/
protected function storeImportJournal(int $index, ImportJournal $importJournal): bool
@@ -139,7 +137,7 @@ class ImportStorage
$transactionType = $this->getTransactionType($amount, $opposingAccount);
$description = $importJournal->getDescription();
/*** First step done! */
// First step done!
$this->job->addStepsDone(1);
/**
@@ -173,12 +171,11 @@ class ImportStorage
'date' => $date,
'hash' => $importJournal->hash,
'amount' => $amount,
];
$journal = $this->storeJournal($parameters);
unset($parameters);
/*** Another step done! */
// Another step done!
$this->job->addStepsDone(1);
// store meta object things:
@@ -202,12 +199,12 @@ class ImportStorage
$journal->completed = true;
$journal->save();
/*** Another step done! */
// Another step done!
$this->job->addStepsDone(1);
// run rules:
$this->applyRules($journal);
/*** Another step done! */
// Another step done!
$this->job->addStepsDone(1);
$this->journals->push($journal);
@@ -224,7 +221,7 @@ class ImportStorage
private function isDoubleTransfer(array $parameters): bool
{
Log::debug('Check if is a double transfer.');
if ($parameters['type'] !== TransactionType::TRANSFER) {
if (TransactionType::TRANSFER !== $parameters['type']) {
Log::debug(sprintf('Is a %s, not a transfer so no.', $parameters['type']));
return false;
@@ -239,23 +236,23 @@ class ImportStorage
foreach ($this->transfers as $transfer) {
$hits = 0;
if ($parameters['description'] === $transfer['description']) {
$hits++;
++$hits;
Log::debug(sprintf('Description "%s" equals "%s", hits = %d', $parameters['description'], $transfer['description'], $hits));
}
if ($names === $transfer['names']) {
$hits++;
++$hits;
Log::debug(sprintf('Involved accounts, "%s" equals "%s", hits = %d', join(',', $names), join(',', $transfer['names']), $hits));
}
if (bccomp($amount, $transfer['amount']) === 0) {
$hits++;
if (0 === bccomp($amount, $transfer['amount'])) {
++$hits;
Log::debug(sprintf('Amount %s equals %s, hits = %d', $amount, $transfer['amount'], $hits));
}
if ($parameters['date'] === $transfer['date']) {
$hits++;
++$hits;
Log::debug(sprintf('Date %s equals %s, hits = %d', $parameters['date'], $transfer['date'], $hits));
}
// number of hits is 4? Then it's a match
if ($hits === 4) {
if (4 === $hits) {
Log::error(
'There already is a transfer imported with these properties. Compare existing with new. ',
['existing' => $transfer, 'new' => $parameters]
@@ -265,7 +262,6 @@ class ImportStorage
}
}
return false;
}
}

44
app/Import/Storage/ImportSupport.php
View File

@@ -18,7 +18,6 @@
* 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\Import\Storage;
@@ -46,17 +45,15 @@ use Illuminate\Support\Collection;
use Log;
/**
* Trait ImportSupport
*
* @package FireflyIII\Import\Storage
* Trait ImportSupport.
*/
trait ImportSupport
{
/** @var int */
protected $defaultCurrencyId = 1;
/** @var ImportJob */
/** @var ImportJob */
protected $job;
/** @var Collection */
/** @var Collection */
protected $rules;
/**
@@ -88,6 +85,7 @@ trait ImportSupport
* @param array $parameters
*
* @return bool
*
* @throws FireflyException
*/
private function createTransaction(array $parameters): bool
@@ -100,7 +98,7 @@ trait ImportSupport
$transaction->foreign_currency_id = $parameters['foreign_currency'];
$transaction->foreign_amount = $parameters['foreign_amount'];
$transaction->save();
if (is_null($transaction->id)) {
if (null === $transaction->id) {
$errorText = join(', ', $transaction->getErrors()->all());
throw new FireflyException($errorText);
}
@@ -129,7 +127,7 @@ trait ImportSupport
// use given currency
$currency = $importJournal->currency->getTransactionCurrency();
if (!is_null($currency->id)) {
if (null !== $currency->id) {
return $currency->id;
}
@@ -154,7 +152,7 @@ trait ImportSupport
{
// use given currency by import journal.
$currency = $importJournal->currency->getTransactionCurrency();
if (!is_null($currency->id) && $currency->id !== $currencyId) {
if (null !== $currency->id && $currency->id !== $currencyId) {
return $currency->id;
}
@@ -226,7 +224,9 @@ trait ImportSupport
* @param Account $account
*
* @return string
*
* @throws FireflyException
*
* @see ImportSupport::getOpposingAccount()
*/
private function getTransactionType(string $amount, Account $account): string
@@ -237,18 +237,18 @@ trait ImportSupport
$transactionType = TransactionType::WITHDRAWAL;
}
if (bccomp($amount, '0') === 1) {
if (1 === bccomp($amount, '0')) {
$transactionType = TransactionType::DEPOSIT;
}
// if opposing is an asset account, it's a transfer:
if ($account->accountType->type === AccountType::ASSET) {
if (AccountType::ASSET === $account->accountType->type) {
Log::debug(sprintf('Opposing account #%d %s is an asset account, make transfer.', $account->id, $account->name));
$transactionType = TransactionType::TRANSFER;
}
// verify that opposing account is of the correct type:
if ($account->accountType->type === AccountType::EXPENSE && $transactionType !== TransactionType::WITHDRAWAL) {
if (AccountType::EXPENSE === $account->accountType->type && TransactionType::WITHDRAWAL !== $transactionType) {
$message = 'This row is imported as a withdrawal but opposing is an expense account. This cannot be!';
Log::error($message);
throw new FireflyException($message);
@@ -289,8 +289,8 @@ trait ImportSupport
->where('transaction_types.type', TransactionType::TRANSFER)
->get(
['transaction_journals.id', 'transaction_journals.encrypted', 'transaction_journals.description',
'source_accounts.name as source_name', 'destination_accounts.name as destination_name', 'destination.amount'
, 'transaction_journals.date']
'source_accounts.name as source_name', 'destination_accounts.name as destination_name', 'destination.amount',
'transaction_journals.date',]
);
$array = [];
/** @var TransactionJournal $entry */
@@ -323,7 +323,7 @@ trait ImportSupport
->where('data', $json)
->where('name', 'importHash')
->first();
if (!is_null($entry)) {
if (null !== $entry) {
Log::error(sprintf('A journal with hash %s has already been imported (spoiler: it\'s journal #%d)', $hash, $entry->transaction_journal_id));
return true;
@@ -338,7 +338,7 @@ trait ImportSupport
*/
private function storeBill(TransactionJournal $journal, Bill $bill)
{
if (!is_null($bill->id)) {
if (null !== $bill->id) {
Log::debug(sprintf('Linked bill #%d to journal #%d', $bill->id, $journal->id));
$journal->bill()->associate($bill);
$journal->save();
@@ -351,7 +351,7 @@ trait ImportSupport
*/
private function storeBudget(TransactionJournal $journal, Budget $budget)
{
if (!is_null($budget->id)) {
if (null !== $budget->id) {
Log::debug(sprintf('Linked budget #%d to journal #%d', $budget->id, $journal->id));
$journal->budgets()->save($budget);
}
@@ -363,7 +363,7 @@ trait ImportSupport
*/
private function storeCategory(TransactionJournal $journal, Category $category)
{
if (!is_null($category->id)) {
if (null !== $category->id) {
Log::debug(sprintf('Linked category #%d to journal #%d', $category->id, $journal->id));
$journal->categories()->save($category);
}
@@ -403,7 +403,7 @@ trait ImportSupport
'currency' => $parameters['currency'],
'amount' => $parameters['amount'],
'foreign_currency' => $parameters['foreign_currency'],
'foreign_amount' => is_null($parameters['foreign_currency']) ? null : $parameters['amount'],
'foreign_amount' => null === $parameters['foreign_currency'] ? null : $parameters['amount'],
];
$opposite = app('steam')->opposite($parameters['amount']);
$two = [
@@ -412,7 +412,7 @@ trait ImportSupport
'currency' => $parameters['currency'],
'amount' => $opposite,
'foreign_currency' => $parameters['foreign_currency'],
'foreign_amount' => is_null($parameters['foreign_currency']) ? null : $opposite,
'foreign_amount' => null === $parameters['foreign_currency'] ? null : $opposite,
];
$this->createTransaction($one);
$this->createTransaction($two);
@@ -449,10 +449,10 @@ trait ImportSupport
foreach ($tags as $tag) {
$dbTag = $repository->findByTag($tag);
if (is_null($dbTag->id)) {
if (null === $dbTag->id) {
$dbTag = $repository->store(
['tag' => $tag, 'date' => null, 'description' => null, 'latitude' => null, 'longitude' => null,
'zoomLevel' => null, 'tagMode' => 'nothing']
'zoomLevel' => null, 'tagMode' => 'nothing',]
);
}
$journal->tags()->save($dbTag);