New triggers and actions for notes. #872

2025-09-29 18:20:01 +00:00 · 2017-10-03 05:28:00 +02:00
parent 7a57c60891
commit 95b5793f63
13 changed files with 1209 additions and 494 deletions
--- a/app/TransactionRules/Triggers/NotesAre.php
+++ b/app/TransactionRules/Triggers/NotesAre.php
@@ -0,0 +1,74 @@
+<?php
+/**
+ * NotesAre.php
+ * Copyright (c) 2017 thegrumpydictator@gmail.com
+ * This software may be modified and distributed under the terms of the
+ * Creative Commons Attribution-ShareAlike 4.0 International License.
+ *
+ * See the LICENSE file for details.
+ */
+
+declare(strict_types=1);
+
+namespace FireflyIII\TransactionRules\Triggers;
+
+use FireflyIII\Models\TransactionJournal;
+use Log;
+
+/**
+ * Class NotesAre
+ *
+ * @package FireflyIII\TransactionRules\Triggers
+ */
+final class NotesAre 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 (!is_null($value)) {
+            return false;
+        }
+
+        Log::error(sprintf('Cannot use %s with a null value.', self::class));
+
+        return true;
+    }
+
+    /**
+     * @param TransactionJournal $journal
+     *
+     * @return bool
+     */
+    public function triggered(TransactionJournal $journal): bool
+    {
+        $notes  = strtolower($journal->getMeta('notes') ?? '');
+        $search = strtolower($this->triggerValue);
+
+        if ($notes === $search) {
+
+            Log::debug(sprintf('RuleTrigger NotesAre for journal #%d: "%s" is "%s", return true.', $journal->id, $notes, $search));
+
+            return true;
+        }
+
+        Log::debug(sprintf('RuleTrigger NotesAre for journal #%d: "%s" is NOT "%s", return false.', $journal->id, $notes, $search));
+
+        return false;
+    }
+}