Change scope of methods, add some notes. Prep for refactoring.

2025-10-12 15:35:15 +00:00 · 2018-08-09 16:07:33 +02:00
parent 32e58d0a60
commit 7943164375
41 changed files with 189 additions and 147 deletions
--- a/app/Support/Http/Controllers/UserNavigation.php
+++ b/app/Support/Http/Controllers/UserNavigation.php
@@ -0,0 +1,96 @@
+<?php
+/**
+ * UserNavigation.php
+ * Copyright (c) 2018 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\Support\Http\Controllers;
+
+use FireflyIII\Models\AccountType;
+use FireflyIII\Models\Transaction;
+use FireflyIII\Models\TransactionJournal;
+use URL;
+
+/**
+ * Trait UserNavigation
+ *
+ * @package FireflyIII\Support\Http\Controllers
+ */
+trait UserNavigation
+{
+    /**
+     * Functionality:.
+     *
+     * - If the $identifier contains the word "delete" then a remembered uri with the text "/show/" in it will not be returned but instead the index (/)
+     *   will be returned.
+     * - If the remembered uri contains "javascript/" the remembered uri will not be returned but instead the index (/) will be returned.
+     *
+     * @param string $identifier
+     *
+     * @return string
+     */
+    protected function getPreviousUri(string $identifier): string
+    {
+        $uri = (string)session($identifier);
+        if (!(false === strpos($identifier, 'delete')) && !(false === strpos($uri, '/show/'))) {
+            $uri = $this->redirectUri;
+        }
+        if (!(false === strpos($uri, 'jscript'))) {
+            $uri = $this->redirectUri; // @codeCoverageIgnore
+        }
+
+        return $uri;
+    }
+
+    /**
+     * Redirect to asset account that transaction belongs to.
+     *
+     * @param TransactionJournal $journal
+     *
+     * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
+     */
+    protected function redirectToAccount(TransactionJournal $journal)
+    {
+        $valid        = [AccountType::DEFAULT, AccountType::ASSET];
+        $transactions = $journal->transactions;
+        /** @var Transaction $transaction */
+        foreach ($transactions as $transaction) {
+            $account = $transaction->account;
+            if (\in_array($account->accountType->type, $valid, true)) {
+                return redirect(route('accounts.show', [$account->id]));
+            }
+        }
+        // @codeCoverageIgnoreStart
+        session()->flash('error', (string)trans('firefly.cannot_redirect_to_account'));
+
+        return redirect(route('index'));
+        // @codeCoverageIgnoreEnd
+    }
+
+    /**
+     * Remember previous URL.
+     *
+     * @param string $identifier
+     */
+    protected function rememberPreviousUri(string $identifier): void
+    {
+        session()->put($identifier, URL::previous());
+    }
+}