Code cleanup

app/Helpers/Collector/Extensions/CollectorProperties.php

@@ -38,16 +38,17 @@ trait CollectorProperties
     private $hasAccountInfo;
     /** @var bool Will be true if query result includes bill information. */
     private $hasBillInformation;
-    /** @var bool */
-    private $hasNotesInformation;
     /** @var bool Will be true if query result contains budget info. */
     private $hasBudgetInformation;
     /** @var bool Will be true if query result contains category info. */
     private $hasCatInformation;
     /** @var bool Will be true for attachments */
     private $hasJoinedAttTables;
+    private bool $hasJoinedMetaTables;
     /** @var bool Will be true of the query has the tag info tables joined. */
     private $hasJoinedTagTables;
+    /** @var bool */
+    private $hasNotesInformation;
     /** @var array */
     private $integerFields;
     /** @var int The maximum number of results. */
@@ -60,6 +61,4 @@ trait CollectorProperties
     private $total;
     /** @var User The user object. */
     private $user;
-
-    private bool $hasJoinedMetaTables;
 }

app/Helpers/Collector/Extensions/MetaCollection.php

@@ -39,84 +39,60 @@ trait MetaCollection
 {
 
     /**
-     * @inheritDoc
+     * Where has no tags.
+     *
+     * @return GroupCollectorInterface
      */
-    public function withNotes(): GroupCollectorInterface
+    public function hasAnyTag(): GroupCollectorInterface
     {
-        if (false === $this->hasNotesInformation) {
-            // join bill table
-            $this->query->leftJoin(
-                'notes',
-                static function (JoinClause $join) {
-                    $join->on('notes.noteable_id', '=', 'transaction_journals.id');
-                    $join->where('notes.noteable_type', '=', 'FireflyIII\Models\TransactionJournal');
-                }
-            );
-            // add fields
-            $this->fields[]            = 'notes.text as notes';
-            $this->hasNotesInformation = true;
-        }
+        $this->withTagInformation();
+        $this->query->whereNotNull('tag_transaction_journal.tag_id');
 
         return $this;
     }
 
-
     /**
      * @param string $value
+     *
      * @return GroupCollectorInterface
      */
     public function notesContain(string $value): GroupCollectorInterface
     {
         $this->withNotes();
         $this->query->where('notes.text', 'LIKE', sprintf('%%%s%%', $value));
+
         return $this;
     }
 
     /**
      * @param string $value
+     *
      * @return GroupCollectorInterface
      */
     public function notesEndWith(string $value): GroupCollectorInterface
     {
         $this->withNotes();
         $this->query->where('notes.text', 'LIKE', sprintf('%%%s', $value));
-        return $this;
-    }
 
-    /**
-     * @return GroupCollectorInterface
-     */
-    public function withoutNotes(): GroupCollectorInterface
-    {
-        $this->withNotes();
-        $this->query->whereNull('notes.text');
-        return $this;
-    }
-
-
-    /**
-     * @return GroupCollectorInterface
-     */
-    public function withAnyNotes(): GroupCollectorInterface
-    {
-        $this->withNotes();
-        $this->query->whereNotNull('notes.text');
         return $this;
     }
 
     /**
      * @param string $value
+     *
      * @return GroupCollectorInterface
      */
     public function notesExactly(string $value): GroupCollectorInterface
     {
         $this->withNotes();
         $this->query->where('notes.text', '=', sprintf('%s', $value));
+
         return $this;
     }
 
     /**
      * @param string $value
+     *
      * @return GroupCollectorInterface
      */
     public function notesStartWith(string $value): GroupCollectorInterface
@@ -124,7 +100,7 @@ trait MetaCollection
         $this->withNotes();
         $this->query->where('notes.text', 'LIKE', sprintf('%s%%', $value));
 
-         return $this;
+        return $this;
     }
 
     /**
@@ -221,219 +197,6 @@ trait MetaCollection
         return $this;
     }
 
-    /**
-     * Limit results to a specific tag.
-     *
-     * @param Tag $tag
-     *
-     * @return GroupCollectorInterface
-     */
-    public function setTag(Tag $tag): GroupCollectorInterface
-    {
-        $this->withTagInformation();
-        $this->query->where('tag_transaction_journal.tag_id', $tag->id);
-
-        return $this;
-    }
-
-    /**
-     * Limit results to a specific set of tags.
-     *
-     * @param Collection $tags
-     *
-     * @return GroupCollectorInterface
-     */
-    public function setTags(Collection $tags): GroupCollectorInterface
-    {
-        $this->withTagInformation();
-        $this->query->whereIn('tag_transaction_journal.tag_id', $tags->pluck('id')->toArray());
-
-        return $this;
-    }
-
-    /**
-     * Where has no tags.
-     *
-     * @return GroupCollectorInterface
-     */
-    public function withoutTags(): GroupCollectorInterface
-    {
-        $this->withTagInformation();
-        $this->query->whereNull('tag_transaction_journal.tag_id');
-
-        return $this;
-    }
-
-    /**
-     * Where has no tags.
-     *
-     * @return GroupCollectorInterface
-     */
-    public function hasAnyTag(): GroupCollectorInterface
-    {
-        $this->withTagInformation();
-        $this->query->whereNotNull('tag_transaction_journal.tag_id');
-
-        return $this;
-    }
-
-    /**
-     * Will include bill name + ID, if any.
-     *
-     * @return GroupCollectorInterface
-     */
-    public function withBillInformation(): GroupCollectorInterface
-    {
-        if (false === $this->hasBillInformation) {
-            // join bill table
-            $this->query->leftJoin('bills', 'bills.id', '=', 'transaction_journals.bill_id');
-            // add fields
-            $this->fields[]           = 'bills.id as bill_id';
-            $this->fields[]           = 'bills.name as bill_name';
-            $this->hasBillInformation = true;
-        }
-
-        return $this;
-    }
-
-    /**
-     * Will include budget ID + name, if any.
-     *
-     * @return GroupCollectorInterface
-     */
-    public function withBudgetInformation(): GroupCollectorInterface
-    {
-        if (false === $this->hasBudgetInformation) {
-            // join link table
-            $this->query->leftJoin('budget_transaction_journal', 'budget_transaction_journal.transaction_journal_id', '=', 'transaction_journals.id');
-            // join cat table
-            $this->query->leftJoin('budgets', 'budget_transaction_journal.budget_id', '=', 'budgets.id');
-            // add fields
-            $this->fields[]             = 'budgets.id as budget_id';
-            $this->fields[]             = 'budgets.name as budget_name';
-            $this->hasBudgetInformation = true;
-        }
-
-        return $this;
-    }
-
-    /**
-     * Will include category ID + name, if any.
-     *
-     * @return GroupCollectorInterface
-     */
-    public function withCategoryInformation(): GroupCollectorInterface
-    {
-        if (false === $this->hasCatInformation) {
-            // join link table
-            $this->query->leftJoin('category_transaction_journal', 'category_transaction_journal.transaction_journal_id', '=', 'transaction_journals.id');
-            // join cat table
-            $this->query->leftJoin('categories', 'category_transaction_journal.category_id', '=', 'categories.id');
-            // add fields
-            $this->fields[]          = 'categories.id as category_id';
-            $this->fields[]          = 'categories.name as category_name';
-            $this->hasCatInformation = true;
-        }
-
-        return $this;
-    }
-
-    /**
-     * @return GroupCollectorInterface
-     */
-    public function withTagInformation(): GroupCollectorInterface
-    {
-        $this->fields[] = 'tags.id as tag_id';
-        $this->fields[] = 'tags.tag as tag_name';
-        $this->fields[] = 'tags.date as tag_date';
-        $this->fields[] = 'tags.description as tag_description';
-        $this->fields[] = 'tags.latitude as tag_latitude';
-        $this->fields[] = 'tags.longitude as tag_longitude';
-        $this->fields[] = 'tags.zoomLevel as tag_zoom_level';
-
-        $this->joinTagTables();
-
-        return $this;
-    }
-
-    /**
-     * Limit results to a transactions without a budget..
-     *
-     * @return GroupCollectorInterface
-     */
-    public function withoutBudget(): GroupCollectorInterface
-    {
-        $this->withBudgetInformation();
-        $this->query->whereNull('budget_transaction_journal.budget_id');
-
-        return $this;
-    }
-
-    /**
-     * Limit results to a transactions without a bill.
-     *
-     * @return GroupCollectorInterface
-     */
-    public function withoutBill(): GroupCollectorInterface
-    {
-        $this->query->whereNull('transaction_journals.bill_id');
-
-        return $this;
-    }
-
-    /**
-     * Limit results to a transactions without a budget..
-     *
-     * @return GroupCollectorInterface
-     */
-    public function withBudget(): GroupCollectorInterface
-    {
-        $this->withBudgetInformation();
-        $this->query->whereNotNull('budget_transaction_journal.budget_id');
-
-        return $this;
-    }
-
-    /**
-     * Limit results to a transactions without a category.
-     *
-     * @return GroupCollectorInterface
-     */
-    public function withoutCategory(): GroupCollectorInterface
-    {
-        $this->withCategoryInformation();
-        $this->query->whereNull('category_transaction_journal.category_id');
-
-        return $this;
-    }
-
-    /**
-     * Limit results to a transactions without a category.
-     *
-     * @return GroupCollectorInterface
-     */
-    public function withCategory(): GroupCollectorInterface
-    {
-        $this->withCategoryInformation();
-        $this->query->whereNotNull('category_transaction_journal.category_id');
-
-        return $this;
-    }
-
-    /**
-     * Join table to get tag information.
-     */
-    protected function joinTagTables(): void
-    {
-        if (false === $this->hasJoinedTagTables) {
-            // join some extra tables:
-            $this->hasJoinedTagTables = true;
-            $this->query->leftJoin('tag_transaction_journal', 'tag_transaction_journal.transaction_journal_id', '=', 'transaction_journals.id');
-            $this->query->leftJoin('tags', 'tag_transaction_journal.tag_id', '=', 'tags.id');
-        }
-    }
-
-
     /**
      * @inheritDoc
      */
@@ -465,5 +228,248 @@ trait MetaCollection
         return $this;
     }
 
+    /**
+     * Limit results to a specific tag.
+     *
+     * @param Tag $tag
+     *
+     * @return GroupCollectorInterface
+     */
+    public function setTag(Tag $tag): GroupCollectorInterface
+    {
+        $this->withTagInformation();
+        $this->query->where('tag_transaction_journal.tag_id', $tag->id);
+
+        return $this;
+    }
+
+    /**
+     * Limit results to a specific set of tags.
+     *
+     * @param Collection $tags
+     *
+     * @return GroupCollectorInterface
+     */
+    public function setTags(Collection $tags): GroupCollectorInterface
+    {
+        $this->withTagInformation();
+        $this->query->whereIn('tag_transaction_journal.tag_id', $tags->pluck('id')->toArray());
+
+        return $this;
+    }
+
+    /**
+     * @return GroupCollectorInterface
+     */
+    public function withAnyNotes(): GroupCollectorInterface
+    {
+        $this->withNotes();
+        $this->query->whereNotNull('notes.text');
+
+        return $this;
+    }
+
+    /**
+     * Will include bill name + ID, if any.
+     *
+     * @return GroupCollectorInterface
+     */
+    public function withBillInformation(): GroupCollectorInterface
+    {
+        if (false === $this->hasBillInformation) {
+            // join bill table
+            $this->query->leftJoin('bills', 'bills.id', '=', 'transaction_journals.bill_id');
+            // add fields
+            $this->fields[]           = 'bills.id as bill_id';
+            $this->fields[]           = 'bills.name as bill_name';
+            $this->hasBillInformation = true;
+        }
+
+        return $this;
+    }
+
+    /**
+     * Limit results to a transactions without a budget..
+     *
+     * @return GroupCollectorInterface
+     */
+    public function withBudget(): GroupCollectorInterface
+    {
+        $this->withBudgetInformation();
+        $this->query->whereNotNull('budget_transaction_journal.budget_id');
+
+        return $this;
+    }
+
+    /**
+     * Will include budget ID + name, if any.
+     *
+     * @return GroupCollectorInterface
+     */
+    public function withBudgetInformation(): GroupCollectorInterface
+    {
+        if (false === $this->hasBudgetInformation) {
+            // join link table
+            $this->query->leftJoin('budget_transaction_journal', 'budget_transaction_journal.transaction_journal_id', '=', 'transaction_journals.id');
+            // join cat table
+            $this->query->leftJoin('budgets', 'budget_transaction_journal.budget_id', '=', 'budgets.id');
+            // add fields
+            $this->fields[]             = 'budgets.id as budget_id';
+            $this->fields[]             = 'budgets.name as budget_name';
+            $this->hasBudgetInformation = true;
+        }
+
+        return $this;
+    }
+
+    /**
+     * Limit results to a transactions without a category.
+     *
+     * @return GroupCollectorInterface
+     */
+    public function withCategory(): GroupCollectorInterface
+    {
+        $this->withCategoryInformation();
+        $this->query->whereNotNull('category_transaction_journal.category_id');
+
+        return $this;
+    }
+
+    /**
+     * Will include category ID + name, if any.
+     *
+     * @return GroupCollectorInterface
+     */
+    public function withCategoryInformation(): GroupCollectorInterface
+    {
+        if (false === $this->hasCatInformation) {
+            // join link table
+            $this->query->leftJoin('category_transaction_journal', 'category_transaction_journal.transaction_journal_id', '=', 'transaction_journals.id');
+            // join cat table
+            $this->query->leftJoin('categories', 'category_transaction_journal.category_id', '=', 'categories.id');
+            // add fields
+            $this->fields[]          = 'categories.id as category_id';
+            $this->fields[]          = 'categories.name as category_name';
+            $this->hasCatInformation = true;
+        }
+
+        return $this;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function withNotes(): GroupCollectorInterface
+    {
+        if (false === $this->hasNotesInformation) {
+            // join bill table
+            $this->query->leftJoin(
+                'notes',
+                static function (JoinClause $join) {
+                    $join->on('notes.noteable_id', '=', 'transaction_journals.id');
+                    $join->where('notes.noteable_type', '=', 'FireflyIII\Models\TransactionJournal');
+                }
+            );
+            // add fields
+            $this->fields[]            = 'notes.text as notes';
+            $this->hasNotesInformation = true;
+        }
+
+        return $this;
+    }
+
+    /**
+     * @return GroupCollectorInterface
+     */
+    public function withTagInformation(): GroupCollectorInterface
+    {
+        $this->fields[] = 'tags.id as tag_id';
+        $this->fields[] = 'tags.tag as tag_name';
+        $this->fields[] = 'tags.date as tag_date';
+        $this->fields[] = 'tags.description as tag_description';
+        $this->fields[] = 'tags.latitude as tag_latitude';
+        $this->fields[] = 'tags.longitude as tag_longitude';
+        $this->fields[] = 'tags.zoomLevel as tag_zoom_level';
+
+        $this->joinTagTables();
+
+        return $this;
+    }
+
+    /**
+     * Limit results to a transactions without a bill.
+     *
+     * @return GroupCollectorInterface
+     */
+    public function withoutBill(): GroupCollectorInterface
+    {
+        $this->query->whereNull('transaction_journals.bill_id');
+
+        return $this;
+    }
+
+    /**
+     * Limit results to a transactions without a budget..
+     *
+     * @return GroupCollectorInterface
+     */
+    public function withoutBudget(): GroupCollectorInterface
+    {
+        $this->withBudgetInformation();
+        $this->query->whereNull('budget_transaction_journal.budget_id');
+
+        return $this;
+    }
+
+    /**
+     * Limit results to a transactions without a category.
+     *
+     * @return GroupCollectorInterface
+     */
+    public function withoutCategory(): GroupCollectorInterface
+    {
+        $this->withCategoryInformation();
+        $this->query->whereNull('category_transaction_journal.category_id');
+
+        return $this;
+    }
+
+    /**
+     * @return GroupCollectorInterface
+     */
+    public function withoutNotes(): GroupCollectorInterface
+    {
+        $this->withNotes();
+        $this->query->whereNull('notes.text');
+
+        return $this;
+    }
+
+    /**
+     * Where has no tags.
+     *
+     * @return GroupCollectorInterface
+     */
+    public function withoutTags(): GroupCollectorInterface
+    {
+        $this->withTagInformation();
+        $this->query->whereNull('tag_transaction_journal.tag_id');
+
+        return $this;
+    }
+
+    /**
+     * Join table to get tag information.
+     */
+    protected function joinTagTables(): void
+    {
+        if (false === $this->hasJoinedTagTables) {
+            // join some extra tables:
+            $this->hasJoinedTagTables = true;
+            $this->query->leftJoin('tag_transaction_journal', 'tag_transaction_journal.transaction_journal_id', '=', 'transaction_journals.id');
+            $this->query->leftJoin('tags', 'tag_transaction_journal.tag_id', '=', 'tags.id');
+        }
+    }
+
 
 }