squash

Author: ildyria

.github/copilot-instructions.md

@@ -2,6 +2,7 @@ Any new php file should contain the license header and has a single blank line a
 The variable name should be in snake_case.
 In Requests, if a user is provided by the query it is placed in the $this->user2.
 In Requests, $this->user is reserved for the user making the request.
+The Resource classes should use Laravel Data instead of JsonResource.
 We do not use blade view, we use Vue3 instead.
 Use Typescript in composition API for Vue3. Use PrimeVue for UI components.
 Do not use await async calls in Vue3, use .then() instead.

app/Constants/AccessPermissionConstants.php

@@ -17,6 +17,7 @@ class AccessPermissionConstants
 	// Id names
 	public const BASE_ALBUM_ID = 'base_album_id';
 	public const USER_ID = 'user_id';
+	public const USER_GROUP_ID = 'user_group_id';
 
 	// Attributes name
 	public const IS_LINK_REQUIRED = 'is_link_required';

app/Contracts/Http/Requests/HasName.php

@@ -0,0 +1,14 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 LycheeOrg.
+ */
+
+namespace App\Contracts\Http\Requests;
+
+interface HasName
+{
+	public function name(): string;
+}

app/Contracts/Http/Requests/HasRole.php

@@ -0,0 +1,16 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 LycheeOrg.
+ */
+
+namespace App\Contracts\Http\Requests;
+
+use App\Enum\UserGroupRole;
+
+interface HasRole
+{
+	public function role(): UserGroupRole;
+}

app/Contracts/Http/Requests/HasUserGroup.php

@@ -0,0 +1,16 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 LycheeOrg.
+ */
+
+namespace App\Contracts\Http\Requests;
+
+use App\Models\UserGroup;
+
+interface HasUserGroup
+{
+	public function user_group(): UserGroup;
+}

app/Contracts/Http/Requests/RequestAttribute.php

@@ -15,6 +15,10 @@ class RequestAttribute
 	public const USER_ID_ATTRIBUTE = 'user_id';
 	public const USER_IDS_ATTRIBUTE = 'user_ids';
 
+	public const GROUP_ID = 'group_id';
+	public const NAME_ATTRIBUTE = 'name';
+	public const ROLE_ATTRIBUTE = 'role';
+
 	public const EMAIL_ATTRIBUTE = 'email';
 	public const ALIAS_ATTRIBUTE = 'alias';
 	public const PROVIDER_ATTRIBUTE = 'provider';

app/Enum/UserGroupRole.php

@@ -0,0 +1,18 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 LycheeOrg.
+ */
+
+namespace App\Enum;
+
+/**
+ * Enum representing the roles a user can have in a user group.
+ */
+enum UserGroupRole: string
+{
+	case MEMBER = 'member';
+	case ADMIN = 'admin';
+}

app/Http/Controllers/Admin/UserGroupsController.php

@@ -0,0 +1,72 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 LycheeOrg.
+ */
+
+namespace App\Http\Controllers\Admin;
+
+use App\Http\Requests\UserGroup\CreateUserGroupRequest;
+use App\Http\Requests\UserGroup\DeleteUserGroupRequest;
+use App\Http\Requests\UserGroup\ListUserGroupRequest;
+use App\Http\Requests\UserGroup\UpdateUserGroupRequest;
+use App\Http\Resources\Collections\UserGroupDataResource;
+use App\Http\Resources\Models\UserGroupResource;
+use App\Models\UserGroup;
+use Illuminate\Routing\Controller;
+use Illuminate\Validation\ValidationException;
+
+/**
+ * Controller responsible for user management.
+ */
+class UserGroupsController extends Controller
+{
+	/**
+	 * @return UserGroupDataResource
+	 */
+	public function list(ListUserGroupRequest $request): UserGroupDataResource
+	{
+		return new UserGroupDataResource(UserGroup::with('users')->get());
+	}
+
+	public function create(CreateUserGroupRequest $request): UserGroupResource
+	{
+		$this->validateUniqueGroupName($request->name());
+
+		$user_group = UserGroup::create([
+			'name' => $request->name(),
+			'description' => $request->description(),
+		]);
+
+		return new UserGroupResource($user_group);
+	}
+
+	public function update(UpdateUserGroupRequest $request): UserGroupResource
+	{
+		$this->validateUniqueGroupName($request->name(), $request->user_group()->id);
+
+		$request->user_group()->update([
+			'name' => $request->name(),
+			'description' => $request->description(),
+		]);
+
+		return new UserGroupResource($request->user_group());
+	}
+
+	public function delete(DeleteUserGroupRequest $request): void
+	{
+		$request->user_group()->delete();
+	}
+
+	private function validateUniqueGroupName(string $name, ?int $exclude_id = null): void
+	{
+		$query = UserGroup::where('name', $name)
+			->when($exclude_id !== null, fn ($q) => $q->where('id', '!=', $exclude_id));
+
+		if ($query->exists()) {
+			throw ValidationException::withMessages(['name' => 'A group with this name already exists.']);
+		}
+	}
+}

app/Http/Controllers/Admin/UserGroupsManagementController.php

@@ -0,0 +1,47 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 LycheeOrg.
+ */
+
+namespace App\Http\Controllers\Admin;
+
+use App\Http\Requests\UserGroup\GetUserGroupRequest;
+use App\Http\Requests\UserGroup\ManageUserGroupRequest;
+use App\Http\Resources\Models\UserGroupResource;
+use Illuminate\Routing\Controller;
+
+/**
+ * Controller responsible for managing users within groups.
+ */
+class UserGroupsManagementController extends Controller
+{
+	public function get(GetUserGroupRequest $request): UserGroupResource
+	{
+		return new UserGroupResource($request->user_group());
+	}
+
+	public function addUser(ManageUserGroupRequest $request): UserGroupResource
+	{
+		$request->user_group()->users()->attach($request->user2()->id, ['role' => $request->role()->value]);
+
+		return new UserGroupResource($request->user_group());
+	}
+
+	public function removeUser(ManageUserGroupRequest $request): UserGroupResource
+	{
+		$request->user_group()->users()->detach($request->user2()->id);
+
+		return new UserGroupResource($request->user_group());
+	}
+
+	public function updateUserRole(ManageUserGroupRequest $request): UserGroupResource
+	{
+		$request->user_group()->users()->updateExistingPivot($request->user2()->id, ['role' => $request->role()->value]);
+		$request->user_group()->load('users');
+
+		return new UserGroupResource($request->user_group());
+	}
+}

app/Http/Requests/Traits/HasNameTrait.php

@@ -0,0 +1,22 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 LycheeOrg.
+ */
+
+namespace App\Http\Requests\Traits;
+
+trait HasNameTrait
+{
+	protected string $name;
+
+	/**
+	 * @return string
+	 */
+	public function name(): string
+	{
+		return $this->name;
+	}
+}