Build a new collector and first view online.

app/Helpers/Collector/GroupCollectorInterface.php

@@ -0,0 +1,88 @@
+<?php
+/**
+ * GroupCollectorInterface.php
+ * Copyright (c) 2019 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\Helpers\Collector;
+
+use Carbon\Carbon;
+use FireflyIII\User;
+use Illuminate\Support\Collection;
+
+/**
+ * Interface GroupCollectorInterface
+ */
+interface GroupCollectorInterface
+{
+    /**
+     * Return the groups.
+     *
+     * @return Collection
+     */
+    public function getGroups(): Collection;
+
+    /**
+     * Define which accounts can be part of the source and destination transactions.
+     *
+     * @param Collection $accounts
+     *
+     * @return GroupCollectorInterface
+     */
+    public function setAccounts(Collection $accounts): GroupCollectorInterface;
+
+    /**
+     * Limit the number of returned entries.
+     *
+     * @param int $limit
+     *
+     * @return GroupCollectorInterface
+     */
+    public function setLimit(int $limit): GroupCollectorInterface;
+
+    /**
+     * Set the page to get.
+     *
+     * @param int $page
+     *
+     * @return GroupCollectorInterface
+     */
+    public function setPage(int $page): GroupCollectorInterface;
+
+    /**
+     * Set the start and end time of the results to return.
+     *
+     * @param Carbon $start
+     * @param Carbon $end
+     *
+     * @return GroupCollectorInterface
+     */
+    public function setRange(Carbon $start, Carbon $end): GroupCollectorInterface;
+
+    /**
+     * Set the user object and start the query.
+     *
+     * @param User $user
+     *
+     * @return GroupCollectorInterface
+     */
+    public function setUser(User $user): GroupCollectorInterface;
+
+}