Refactor journal repository and fix tests.

app/Repositories/Journal/JournalAPIRepositoryInterface.php

@@ -0,0 +1,65 @@
+<?php
+/**
+ * JournalAPIRepositoryInterface.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/>.
+ */
+
+namespace FireflyIII\Repositories\Journal;
+
+use FireflyIII\Models\Transaction;
+use FireflyIII\Models\TransactionJournal;
+use FireflyIII\User;
+use Illuminate\Support\Collection;
+
+/**
+ * Interface JournalAPIRepositoryInterface
+ */
+interface JournalAPIRepositoryInterface
+{
+    /**
+     * Returns transaction by ID. Used to validate attachments.
+     *
+     * @param int $transactionId
+     *
+     * @return Transaction|null
+     */
+    public function findTransaction(int $transactionId): ?Transaction;
+
+    /**
+     * Return all attachments for journal.
+     *
+     * @param TransactionJournal $journal
+     *
+     * @return Collection
+     */
+    public function getAttachments(TransactionJournal $journal): Collection;
+
+    /**
+     * Get all piggy bank events for a journal.
+     *
+     * @param TransactionJournal $journal
+     *
+     * @return Collection
+     */
+    public function getPiggyBankEvents(TransactionJournal $journal): Collection;
+
+    /**
+     * @param User $user
+     */
+    public function setUser(User $user);
+}