Expand search with negated search options

2025-10-12 15:35:15 +00:00 · 2022-09-25 15:31:07 +02:00
parent 80a732b32b
commit 3c33ea959e
8 changed files with 1570 additions and 108 deletions
--- a/app/Helpers/Collector/GroupCollectorInterface.php
+++ b/app/Helpers/Collector/GroupCollectorInterface.php
@@ -48,6 +48,12 @@ interface GroupCollectorInterface
     */
    public function amountIs(string $amount): GroupCollectorInterface;

+    /**
+     * @param string $amount
+     *
+     * @return GroupCollectorInterface
+     */
+    public function amountIsNot(string $amount): GroupCollectorInterface;

    /**
     * Only journals that are reconciled.
@@ -56,6 +62,13 @@ interface GroupCollectorInterface
     */
    public function isReconciled(): GroupCollectorInterface;

+    /**
+     * Only journals that are reconciled.
+     *
+     * @return GroupCollectorInterface
+     */
+    public function isNotReconciled(): GroupCollectorInterface;
+
    /**
     * @return GroupCollectorInterface
     */
@@ -145,6 +158,12 @@ interface GroupCollectorInterface
     */
    public function dayIs(string $day): GroupCollectorInterface;

+    /**
+     * @param string $day
+     * @return GroupCollectorInterface
+     */
+    public function dayIsNot(string $day): GroupCollectorInterface;
+
    /**
     * End of the description must match:
     *
@@ -154,6 +173,15 @@ interface GroupCollectorInterface
     */
    public function descriptionEnds(array $array): GroupCollectorInterface;

+    /**
+     * End of the description must not match:
+     *
+     * @param array $array
+     *
+     * @return GroupCollectorInterface
+     */
+    public function descriptionDoesNotEnd(array $array): GroupCollectorInterface;
+
    /**
     * Description must be:
     *
@@ -163,6 +191,15 @@ interface GroupCollectorInterface
     */
    public function descriptionIs(string $value): GroupCollectorInterface;

+    /**
+     * Description must not be:
+     *
+     * @param string $value
+     *
+     * @return GroupCollectorInterface
+     */
+    public function descriptionIsNot(string $value): GroupCollectorInterface;
+
    /**
     * Beginning of the description must match:
     *
@@ -172,6 +209,16 @@ interface GroupCollectorInterface
     */
    public function descriptionStarts(array $array): GroupCollectorInterface;

+    /**
+     * Beginning of the description must not start with:
+     *
+     * @param array $array
+     *
+     * @return GroupCollectorInterface
+     */
+    public function descriptionDoesNotStart(array $array): GroupCollectorInterface;
+
+
    /**
     * Exclude destination accounts.
     *
@@ -190,6 +237,15 @@ interface GroupCollectorInterface
     */
    public function excludeSourceAccounts(Collection $accounts): GroupCollectorInterface;

+    /**
+     * These accounts must not be accounts.
+     *
+     * @param Collection $accounts
+     *
+     * @return GroupCollectorInterface
+     */
+    public function excludeAccounts(Collection $accounts): GroupCollectorInterface;
+
    /**
     * @param string $externalId
     * @return GroupCollectorInterface
@@ -242,6 +298,15 @@ interface GroupCollectorInterface
     */
    public function foreignAmountIs(string $amount): GroupCollectorInterface;

+    /**
+     * Get transactions with a specific foreign amount.
+     *
+     * @param string $amount
+     *
+     * @return GroupCollectorInterface
+     */
+    public function foreignAmountIsNot(string $amount): GroupCollectorInterface;
+
    /**
     * Get transactions where the amount is less than.
     *
@@ -339,6 +404,13 @@ interface GroupCollectorInterface
     */
    public function metaDayIs(string $day, string $field): GroupCollectorInterface;

+    /**
+     * @param string $day
+     * @param string $field
+     * @return GroupCollectorInterface
+     */
+    public function metaDayIsNot(string $day, string $field): GroupCollectorInterface;
+
    /**
     * @param string $month
     * @param string $field
@@ -360,6 +432,13 @@ interface GroupCollectorInterface
     */
    public function metaMonthIs(string $month, string $field): GroupCollectorInterface;

+    /**
+     * @param string $month
+     * @param string $field
+     * @return GroupCollectorInterface
+     */
+    public function metaMonthIsNot(string $month, string $field): GroupCollectorInterface;
+
    /**
     * @param string $year
     * @param string $field
@@ -381,6 +460,14 @@ interface GroupCollectorInterface
     */
    public function metaYearIs(string $year, string $field): GroupCollectorInterface;

+
+    /**
+     * @param string $year
+     * @param string $field
+     * @return GroupCollectorInterface
+     */
+    public function metaYearIsNot(string $year, string $field): GroupCollectorInterface;
+
    /**
     * @param string $month
     * @return GroupCollectorInterface
@@ -399,6 +486,12 @@ interface GroupCollectorInterface
     */
    public function monthIs(string $month): GroupCollectorInterface;

+    /**
+     * @param string $month
+     * @return GroupCollectorInterface
+     */
+    public function monthIsNot(string $month): GroupCollectorInterface;
+
    /**
     * @param string $value
     *
@@ -406,6 +499,13 @@ interface GroupCollectorInterface
     */
    public function notesContain(string $value): GroupCollectorInterface;

+    /**
+     * @param string $value
+     *
+     * @return GroupCollectorInterface
+     */
+    public function notesDoNotContain(string $value): GroupCollectorInterface;
+
    /**
     * @param string $value
     *
@@ -413,6 +513,13 @@ interface GroupCollectorInterface
     */
    public function notesEndWith(string $value): GroupCollectorInterface;

+    /**
+     * @param string $value
+     *
+     * @return GroupCollectorInterface
+     */
+    public function notesDontEndWith(string $value): GroupCollectorInterface;
+
    /**
     * @param string $value
     *
@@ -420,6 +527,13 @@ interface GroupCollectorInterface
     */
    public function notesExactly(string $value): GroupCollectorInterface;

+    /**
+     * @param string $value
+     *
+     * @return GroupCollectorInterface
+     */
+    public function notesExactlyNot(string $value): GroupCollectorInterface;
+
    /**
     * @param string $value
     *
@@ -427,6 +541,12 @@ interface GroupCollectorInterface
     */
    public function notesStartWith(string $value): GroupCollectorInterface;

+    /**
+     * @param string $value
+     * @return GroupCollectorInterface
+     */
+    public function notesDontStartWith(string $value): GroupCollectorInterface;
+
    /**
     * @param string $day
     * @param string $field
@@ -448,6 +568,13 @@ interface GroupCollectorInterface
     */
    public function objectDayIs(string $day, string $field): GroupCollectorInterface;

+    /**
+     * @param string $day
+     * @param string $field
+     * @return GroupCollectorInterface
+     */
+    public function objectDayIsNot(string $day, string $field): GroupCollectorInterface;
+
    /**
     * @param string $month
     * @param string $field
@@ -469,6 +596,13 @@ interface GroupCollectorInterface
     */
    public function objectMonthIs(string $month, string $field): GroupCollectorInterface;

+    /**
+     * @param string $month
+     * @param string $field
+     * @return GroupCollectorInterface
+     */
+    public function objectMonthIsNot(string $month, string $field): GroupCollectorInterface;
+
    /**
     * @param string $year
     * @param string $field
@@ -490,6 +624,13 @@ interface GroupCollectorInterface
     */
    public function objectYearIs(string $year, string $field): GroupCollectorInterface;

+    /**
+     * @param string $year
+     * @param string $field
+     * @return GroupCollectorInterface
+     */
+    public function objectYearIsNot(string $year, string $field): GroupCollectorInterface;
+
    /**
     * Define which accounts can be part of the source and destination transactions.
     *
@@ -499,6 +640,18 @@ interface GroupCollectorInterface
     */
    public function setAccounts(Collection $accounts): GroupCollectorInterface;

+
+    /**
+     * Define which accounts can NOT be part of the source and destination transactions.
+     *
+     * @param Collection $accounts
+     *
+     * @return GroupCollectorInterface
+     */
+    public function setNotAccounts(Collection $accounts): GroupCollectorInterface;
+
+
+
    /**
     * Collect transactions after a specific date.
     *
@@ -535,6 +688,15 @@ interface GroupCollectorInterface
     */
    public function setBills(Collection $bills): GroupCollectorInterface;

+    /**
+     * Exclude a specific set of bills
+     *
+     * @param Collection $bills
+     *
+     * @return GroupCollectorInterface
+     */
+    public function excludeBills(Collection $bills): GroupCollectorInterface;
+
    /**
     * Both source AND destination must be in this list of accounts.
     *
@@ -553,6 +715,15 @@ interface GroupCollectorInterface
     */
    public function setBudget(Budget $budget): GroupCollectorInterface;

+    /**
+     * Exclude a budget
+     *
+     * @param Budget $budget
+     *
+     * @return GroupCollectorInterface
+     */
+    public function excludeBudget(Budget $budget): GroupCollectorInterface;
+
    /**
     * Limit the search to a specific set of budgets.
     *
@@ -562,6 +733,15 @@ interface GroupCollectorInterface
     */
    public function setBudgets(Collection $budgets): GroupCollectorInterface;

+    /**
+     * Exclude a budget.
+     *
+     * @param Collection $budgets
+     *
+     * @return GroupCollectorInterface
+     */
+    public function excludeBudgets(Collection $budgets): GroupCollectorInterface;
+
    /**
     * Limit the search to a specific bunch of categories.
     *
@@ -572,13 +752,12 @@ interface GroupCollectorInterface
    public function setCategories(Collection $categories): GroupCollectorInterface;

    /**
-     * Limit the search not to have a specific bunch of categories.
+     * Exclude a set of categories.
     *
     * @param Collection $categories
-     *
     * @return GroupCollectorInterface
     */
-    public function setNotCategories(Collection $categories): GroupCollectorInterface;
+    public function excludeCategories(Collection $categories): GroupCollectorInterface;

    /**
     * Limit the search to a specific category.
@@ -589,6 +768,15 @@ interface GroupCollectorInterface
     */
    public function setCategory(Category $category): GroupCollectorInterface;

+    /**
+     * Exclude a specific category
+     *
+     * @param Category $category
+     *
+     * @return GroupCollectorInterface
+     */
+    public function excludeCategory(Category $category): GroupCollectorInterface;
+
    /**
     * Collect transactions created on a specific date.
     *
@@ -607,6 +795,15 @@ interface GroupCollectorInterface
     */
    public function setCurrency(TransactionCurrency $currency): GroupCollectorInterface;

+    /**
+     * Limit results to NOT a specific currency, either foreign or normal one.
+     *
+     * @param TransactionCurrency $currency
+     *
+     * @return GroupCollectorInterface
+     */
+    public function excludeCurrency(TransactionCurrency $currency): GroupCollectorInterface;
+
    /**
     * Set destination accounts.
     *
@@ -640,6 +837,15 @@ interface GroupCollectorInterface
     */
    public function setForeignCurrency(TransactionCurrency $currency): GroupCollectorInterface;

+    /**
+     * Limit results to exclude a specific foreign currency.
+     *
+     * @param TransactionCurrency $currency
+     *
+     * @return GroupCollectorInterface
+     */
+    public function excludeForeignCurrency(TransactionCurrency $currency): GroupCollectorInterface;
+
    /**
     * Limit the result to a set of specific transaction groups.
     *
@@ -649,6 +855,15 @@ interface GroupCollectorInterface
     */
    public function setIds(array $groupIds): GroupCollectorInterface;

+    /**
+     * Limit the result to NOT a set of specific transaction groups.
+     *
+     * @param array $groupIds
+     *
+     * @return GroupCollectorInterface
+     */
+    public function excludeIds(array $groupIds): GroupCollectorInterface;
+
    /**
     * Look for specific external ID's.
     *
@@ -667,6 +882,15 @@ interface GroupCollectorInterface
     */
    public function setJournalIds(array $journalIds): GroupCollectorInterface;

+    /**
+     * Limit the result to NOT a set of specific transaction journals.
+     *
+     * @param array $journalIds
+     *
+     * @return GroupCollectorInterface
+     */
+    public function excludeJournalIds(array $journalIds): GroupCollectorInterface;
+
    /**
     * Limit the number of returned entries.
     *
@@ -705,6 +929,16 @@ interface GroupCollectorInterface
     */
    public function setMetaDateRange(Carbon $start, Carbon $end, string $field): GroupCollectorInterface;

+    /**
+     * @param Carbon $start
+     * @param Carbon $end
+     * @param string $field
+     * @return GroupCollectorInterface
+     */
+    public function excludeMetaDateRange(Carbon $start, Carbon $end, string $field): GroupCollectorInterface;
+
+
+
    /**
     * @param Carbon $date
     * @param string $field
@@ -727,6 +961,14 @@ interface GroupCollectorInterface
     */
    public function setObjectRange(Carbon $start, Carbon $end, string $field): GroupCollectorInterface;

+    /**
+     * @param Carbon $start
+     * @param Carbon $end
+     * @param string $field
+     * @return GroupCollectorInterface
+     */
+    public function excludeObjectRange(Carbon $start, Carbon $end, string $field): GroupCollectorInterface;
+
    /**
     * Set the page to get.
     *
@@ -746,6 +988,13 @@ interface GroupCollectorInterface
     */
    public function setRange(Carbon $start, Carbon $end): GroupCollectorInterface;

+    /**
+     * @param Carbon $start
+     * @param Carbon $end
+     * @return GroupCollectorInterface
+     */
+    public function excludeRange(Carbon $start, Carbon $end): GroupCollectorInterface;
+
    /**
     * Look for specific recurring ID's.
     *
@@ -764,6 +1013,15 @@ interface GroupCollectorInterface
     */
    public function setSearchWords(array $array): GroupCollectorInterface;

+    /**
+     * Exclude words in descriptions.
+     *
+     * @param array $array
+     *
+     * @return GroupCollectorInterface
+     */
+    public function excludeSearchWords(array $array): GroupCollectorInterface;
+
    /**
     * Set source accounts.
     *
@@ -809,6 +1067,15 @@ interface GroupCollectorInterface
     */
    public function setTypes(array $types): GroupCollectorInterface;

+    /**
+     * Limit the included transaction types.
+     *
+     * @param array $types
+     *
+     * @return GroupCollectorInterface
+     */
+    public function excludeTypes(array $types): GroupCollectorInterface;
+
    /**
     * Collect transactions updated on a specific date.
     *
@@ -1000,5 +1267,11 @@ interface GroupCollectorInterface
     */
    public function yearIs(string $year): GroupCollectorInterface;

+    /**
+     * @param string $year
+     * @return GroupCollectorInterface
+     */
+    public function yearIsNot(string $year): GroupCollectorInterface;
+

 }