Expand documentation for Helper directory.

app/Helpers/Collector/JournalCollectorInterface.php

@@ -38,6 +38,8 @@ interface JournalCollectorInterface
 {
 
     /**
+     * Add a specific filter.
+     *
      * @param string $filter
      *
      * @return JournalCollectorInterface
@@ -45,6 +47,8 @@ interface JournalCollectorInterface
     public function addFilter(string $filter): JournalCollectorInterface;
 
     /**
+     * Get transactions with a specific amount.
+     *
      * @param string $amount
      *
      * @return JournalCollectorInterface
@@ -52,6 +56,8 @@ interface JournalCollectorInterface
     public function amountIs(string $amount): JournalCollectorInterface;
 
     /**
+     * Get transactions where the amount is less than.
+     *
      * @param string $amount
      *
      * @return JournalCollectorInterface
@@ -59,6 +65,8 @@ interface JournalCollectorInterface
     public function amountLess(string $amount): JournalCollectorInterface;
 
     /**
+     * Get transactions where the amount is more than.
+     *
      * @param string $amount
      *
      * @return JournalCollectorInterface
@@ -66,31 +74,44 @@ interface JournalCollectorInterface
     public function amountMore(string $amount): JournalCollectorInterface;
 
     /**
+     * Count the result.
+     *
      * @return int
      */
     public function count(): int;
 
     /**
+     * Get all journals.
+     * TODO rename me.
+     *
      * @return Collection
      */
     public function getJournals(): Collection;
 
     /**
+     * Get a paginated result.
+     *
      * @return LengthAwarePaginator
      */
     public function getPaginatedJournals(): LengthAwarePaginator;
 
     /**
+     * Get the query.
+     *
      * @return EloquentBuilder
      */
     public function getQuery(): EloquentBuilder;
 
     /**
+     * Set to ignore the cache.
+     *
      * @return JournalCollectorInterface
      */
     public function ignoreCache(): JournalCollectorInterface;
 
     /**
+     * Remove a filter.
+     *
      * @param string $filter
      *
      * @return JournalCollectorInterface
@@ -98,6 +119,8 @@ interface JournalCollectorInterface
     public function removeFilter(string $filter): JournalCollectorInterface;
 
     /**
+     * Set the accounts to collect from.
+     *
      * @param Collection $accounts
      *
      * @return JournalCollectorInterface
@@ -105,6 +128,8 @@ interface JournalCollectorInterface
     public function setAccounts(Collection $accounts): JournalCollectorInterface;
 
     /**
+     * Collect journals after a specific date.
+     *
      * @param Carbon $after
      *
      * @return JournalCollectorInterface
@@ -112,11 +137,15 @@ interface JournalCollectorInterface
     public function setAfter(Carbon $after): JournalCollectorInterface;
 
     /**
+     * Include all asset accounts.
+     *
      * @return JournalCollectorInterface
      */
     public function setAllAssetAccounts(): JournalCollectorInterface;
 
     /**
+     * Collect journals before a specific date.
+     *
      * @param Carbon $before
      *
      * @return JournalCollectorInterface
@@ -124,6 +153,8 @@ interface JournalCollectorInterface
     public function setBefore(Carbon $before): JournalCollectorInterface;
 
     /**
+     * Set the bills to filter on.
+     *
      * @param Collection $bills
      *
      * @return JournalCollectorInterface
@@ -131,6 +162,8 @@ interface JournalCollectorInterface
     public function setBills(Collection $bills): JournalCollectorInterface;
 
     /**
+     * Set the budget to filter on.
+     *
      * @param Budget $budget
      *
      * @return JournalCollectorInterface
@@ -138,6 +171,8 @@ interface JournalCollectorInterface
     public function setBudget(Budget $budget): JournalCollectorInterface;
 
     /**
+     * Set the budgets to filter on.
+     *
      * @param Collection $budgets
      *
      * @return JournalCollectorInterface
@@ -145,6 +180,8 @@ interface JournalCollectorInterface
     public function setBudgets(Collection $budgets): JournalCollectorInterface;
 
     /**
+     * Set the categories to filter on.
+     *
      * @param Collection $categories
      *
      * @return JournalCollectorInterface
@@ -152,6 +189,8 @@ interface JournalCollectorInterface
     public function setCategories(Collection $categories): JournalCollectorInterface;
 
     /**
+     * Set the category to filter on.
+     *
      * @param Category $category
      *
      * @return JournalCollectorInterface
@@ -159,6 +198,8 @@ interface JournalCollectorInterface
     public function setCategory(Category $category): JournalCollectorInterface;
 
     /**
+     * Set the journals to filter on.
+     *
      * @param Collection $journals
      *
      * @return JournalCollectorInterface
@@ -166,6 +207,8 @@ interface JournalCollectorInterface
     public function setJournals(Collection $journals): JournalCollectorInterface;
 
     /**
+     * Set the page limit.
+     *
      * @param int $limit
      *
      * @return JournalCollectorInterface
@@ -173,6 +216,8 @@ interface JournalCollectorInterface
     public function setLimit(int $limit): JournalCollectorInterface;
 
     /**
+     * Set the offset.
+     *
      * @param int $offset
      *
      * @return JournalCollectorInterface
@@ -180,6 +225,8 @@ interface JournalCollectorInterface
     public function setOffset(int $offset): JournalCollectorInterface;
 
     /**
+     * Set the opposing accounts to collect from.
+     *
      * @param Collection $accounts
      *
      * @return JournalCollectorInterface
@@ -187,6 +234,8 @@ interface JournalCollectorInterface
     public function setOpposingAccounts(Collection $accounts): JournalCollectorInterface;
 
     /**
+     * Set the page to get.
+     *
      * @param int $page
      *
      * @return JournalCollectorInterface
@@ -194,6 +243,8 @@ interface JournalCollectorInterface
     public function setPage(int $page): JournalCollectorInterface;
 
     /**
+     * Set the date range.
+     *
      * @param Carbon $start
      * @param Carbon $end
      *
@@ -202,6 +253,8 @@ interface JournalCollectorInterface
     public function setRange(Carbon $start, Carbon $end): JournalCollectorInterface;
 
     /**
+     * Set the tag to collect from.
+     *
      * @param Tag $tag
      *
      * @return JournalCollectorInterface
@@ -209,6 +262,8 @@ interface JournalCollectorInterface
     public function setTag(Tag $tag): JournalCollectorInterface;
 
     /**
+     * Set the tags to collect from.
+     *
      * @param Collection $tags
      *
      * @return JournalCollectorInterface
@@ -216,6 +271,8 @@ interface JournalCollectorInterface
     public function setTags(Collection $tags): JournalCollectorInterface;
 
     /**
+     * Set the types to collect.
+     *
      * @param array $types
      *
      * @return JournalCollectorInterface
@@ -223,6 +280,8 @@ interface JournalCollectorInterface
     public function setTypes(array $types): JournalCollectorInterface;
 
     /**
+     * Set the user.
+     *
      * @param User $user
      *
      * @return mixed
@@ -230,31 +289,41 @@ interface JournalCollectorInterface
     public function setUser(User $user);
 
     /**
-     *
+     * Start the query.
      */
     public function startQuery();
 
     /**
+     * Include budget information.
+     *
      * @return JournalCollectorInterface
      */
     public function withBudgetInformation(): JournalCollectorInterface;
 
     /**
+     * Include category information.
+     *
      * @return JournalCollectorInterface
      */
     public function withCategoryInformation(): JournalCollectorInterface;
 
     /**
+     * Include opposing account information.
+     *
      * @return JournalCollectorInterface
      */
     public function withOpposingAccount(): JournalCollectorInterface;
 
     /**
+     * Include tranactions without a budget.
+     *
      * @return JournalCollectorInterface
      */
     public function withoutBudget(): JournalCollectorInterface;
 
     /**
+     * Include tranactions without a category.
+     *
      * @return JournalCollectorInterface
      */
     public function withoutCategory(): JournalCollectorInterface;