Expand API with better user group management.

2025-11-20 08:30:06 +00:00 · 2023-09-20 06:17:56 +02:00
parent 549f3c038a
commit 1c41b6753d
31 changed files with 853 additions and 146 deletions
--- a/app/Api/V2/Controllers/UserGroup/ShowController.php
+++ b/app/Api/V2/Controllers/UserGroup/ShowController.php
@@ -0,0 +1,97 @@
+<?php
+/*
+ * ShowController.php
+ * Copyright (c) 2023 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/>.
+ */
+
+namespace FireflyIII\Api\V2\Controllers\UserGroup;
+
+use FireflyIII\Api\V2\Controllers\Controller;
+use FireflyIII\Models\UserGroup;
+use FireflyIII\Repositories\UserGroup\UserGroupRepositoryInterface;
+use FireflyIII\Transformers\V2\UserGroupTransformer;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Http\Request;
+use Illuminate\Pagination\LengthAwarePaginator;
+use Illuminate\Support\Collection;
+
+/**
+ * Class ShowController
+ */
+class ShowController extends Controller
+{
+    private UserGroupRepositoryInterface $repository;
+
+    /**
+     *
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                $this->repository = app(UserGroupRepositoryInterface::class);
+
+                return $next($request);
+            }
+        );
+    }
+
+    /**
+     * @param Request $request
+     *
+     * @return JsonResponse
+     */
+    public function index(Request $request): JsonResponse
+    {
+        $collection = new Collection();
+        // if the user has the system owner role, get all. Otherwise, get only the users' groups.
+        if (!auth()->user()->hasRole('owner')) {
+            $collection = $this->repository->get();
+        }
+        if (auth()->user()->hasRole('owner')) {
+            $collection = $this->repository->getAll();
+        }
+        $count      = $collection->count();
+        $userGroups = $collection->slice(($this->parameters->get('page') - 1) * $this->pageSize, $this->pageSize);
+
+        $paginator   = new LengthAwarePaginator($userGroups, $count, $this->pageSize, $this->parameters->get('page'));
+        $transformer = new UserGroupTransformer();
+        $transformer->setParameters($this->parameters); // give params to transformer
+
+        return response()
+            ->json($this->jsonApiList('user-groups', $paginator, $transformer))
+            ->header('Content-Type', self::CONTENT_TYPE);
+    }
+
+    /**
+     * @param Request   $request
+     * @param UserGroup $userGroup
+     *
+     * @return JsonResponse
+     */
+    public function show(Request $request, UserGroup $userGroup): JsonResponse
+    {
+        $transformer = new UserGroupTransformer();
+        $transformer->setParameters($this->parameters);
+
+        return response()
+            ->api($this->jsonApiObject('user-groups', $userGroup, $transformer))
+            ->header('Content-Type', self::CONTENT_TYPE);
+    }
+}