Code for #1324

2026-01-07 14:41:20 +00:00 · 2018-04-08 16:27:52 +02:00
parent 7583698ee5
commit 8f0e36a8e4
18 changed files with 377 additions and 165 deletions
--- a/app/TransactionRules/Triggers/CurrencyIs.php
+++ b/app/TransactionRules/Triggers/CurrencyIs.php
@@ -0,0 +1,92 @@
+<?php
+/**
+ * CurrencyIs.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\TransactionRules\Triggers;
+
+use FireflyIII\Models\Transaction;
+use FireflyIII\Models\TransactionJournal;
+use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface;
+use Log;
+
+/**
+ * Class CurrencyIs.
+ */
+final class CurrencyIs extends AbstractTrigger implements TriggerInterface
+{
+    /**
+     * A trigger is said to "match anything", or match any given transaction,
+     * when the trigger value is very vague or has no restrictions. Easy examples
+     * are the "AmountMore"-trigger combined with an amount of 0: any given transaction
+     * has an amount of more than zero! Other examples are all the "Description"-triggers
+     * which have hard time handling empty trigger values such as "" or "*" (wild cards).
+     *
+     * If the user tries to create such a trigger, this method MUST return true so Firefly III
+     * can stop the storing / updating the trigger. If the trigger is in any way restrictive
+     * (even if it will still include 99.9% of the users transactions), this method MUST return
+     * false.
+     *
+     * @param null $value
+     *
+     * @return bool
+     */
+    public static function willMatchEverything($value = null)
+    {
+        if (null !== $value) {
+            return false;
+        }
+
+        Log::error(sprintf('Cannot use %s with a null value.', self::class));
+
+        return true;
+    }
+
+    /**
+     * Returns true when description is X
+     *
+     * @param TransactionJournal $journal
+     *
+     * @return bool
+     */
+    public function triggered(TransactionJournal $journal): bool
+    {
+        /** @var CurrencyRepositoryInterface $repository */
+        $repository = app(CurrencyRepositoryInterface::class);
+        $currency   = $repository->findByNameNull($this->triggerValue);
+        $hit        = true;
+        if (null !== $currency) {
+            /** @var Transaction $transaction */
+            foreach ($journal->transactions as $transaction) {
+                if ((int)$transaction->transaction_currency_id !== (int)$currency->id) {
+                    Log::debug(
+                        sprintf(
+                            'Trigger CurrencyIs: Transaction #%d in journal #%d uses currency %d instead of sought for #%d. No hit!',
+                            $transaction->id, $journal->id, $transaction->transaction_currency_id, $currency->id
+                        )
+                    );
+                    $hit = false;
+                }
+            }
+        }
+
+        return $hit;
+    }
+}