Various API updates.

2025-10-12 15:35:15 +00:00 · 2024-07-27 15:42:43 +02:00
parent 1c8c038735
commit 16e742ae73
15 changed files with 377 additions and 197 deletions
--- a/app/Support/JsonApi/Concerns/UserGroupDetectable.php
+++ b/app/Support/JsonApi/Concerns/UserGroupDetectable.php
@@ -0,0 +1,63 @@
+<?php
+/*
+ * UserGroupDetectable.php
+ * Copyright (c) 2024 james@firefly-iii.org.
+ *
+ * This file is part of Firefly III (https://github.com/firefly-iii).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see https://www.gnu.org/licenses/.
+ */
+
+declare(strict_types=1);
+
+namespace FireflyIII\Support\JsonApi\Concerns;
+
+use FireflyIII\Models\UserGroup;
+use FireflyIII\User;
+
+trait UserGroupDetectable
+{
+
+    /**
+     * Return the user group or NULL if none is set.
+     * Will throw exception if invalid.
+     * TODO Duplicate from API v2 code.
+     */
+    public function detectUserGroup(): ?UserGroup
+    {
+        /** @var User $user */
+        $user      = auth()->user();
+        app('log')->debug('Now in detectUserGroup()');
+
+        /** @var null|UserGroup $userGroup */
+        $userGroup = request()->route()?->parameter('userGroup');
+        if (null === $userGroup) {
+            app('log')->debug('Request class has no userGroup parameter, but perhaps there is a parameter.');
+            $userGroupId = (int)request()->get('user_group_id');
+            if (0 === $userGroupId) {
+                app('log')->debug(sprintf('Request class has no user_group_id parameter, grab default from user (group #%d).', $user->user_group_id));
+                $userGroupId = (int)$user->user_group_id;
+            }
+            $userGroup   = UserGroup::find($userGroupId);
+            if (null === $userGroup) {
+                app('log')->error(sprintf('Request class has user_group_id (#%d), but group does not exist.', $userGroupId));
+
+                return null;
+            }
+            app('log')->debug('Request class has valid user_group_id.');
+        }
+
+        return $userGroup;
+    }
+}