start working on user groups

Author: ildyria

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/Models/Builders/UserGroupBuilder.php

@@ -0,0 +1,20 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 LycheeOrg.
+ */
+
+namespace App\Models\Builders;
+
+use App\Eloquent\FixedQueryBuilder;
+
+/**
+ * Specialized query builder for {@link \App\Models\UserGroup}.
+ *
+ * @extends FixedQueryBuilder<\App\Models\UserGroup>
+ */
+class UserGroupBuilder extends FixedQueryBuilder
+{
+}

app/Models/UserGroup.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace App\Models;
+
+use App\Constants\AccessPermissionConstants as APC;
+use App\Models\Builders\UserGroupBuilder;
+use App\Models\Extensions\ThrowsConsistentExceptions;
+use App\Models\Extensions\ToArrayThrowsNotImplemented;
+use App\Models\Extensions\UTCBasedTimes;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Query\Builder as BaseBuilder;
+
+/**
+ * App\Models\UserGroup.
+ *
+ * @property int    $id
+ * @property string $name
+ * @property Carbon $created_at
+ * @property Carbon $updated_at
+ */
+class UserGroup extends Model
+{
+	use UTCBasedTimes;
+	use ThrowsConsistentExceptions {
+		delete as parentDelete;
+	}
+	use ToArrayThrowsNotImplemented;
+
+	/**
+	 * @var array<int,string> the attributes that are mass assignable
+	 */
+	protected $fillable = [
+		'name',
+	];
+
+	/**
+	 * @return array<string, string>
+	 */
+	protected function casts(): array
+	{
+		return [
+			'id' => 'integer',
+			'created_at' => 'datetime',
+			'updated_at' => 'datetime',
+		];
+	}
+
+	protected $hidden = [];
+
+	/**
+	 * Create a new Eloquent query builder for the model.
+	 *
+	 * @param BaseBuilder $query
+	 *
+	 * @return UserGroupBuilder
+	 */
+	public function newEloquentBuilder($query): UserGroupBuilder
+	{
+		return new UserGroupBuilder($query);
+	}
+
+	/**
+	 * Returns the relationship between an album and its associated permissions.
+	 *
+	 * @return hasMany<AccessPermission,$this>
+	 */
+	public function access_permissions(): HasMany
+	{
+		return $this->hasMany(AccessPermission::class, APC::USER_GROUP_ID, 'id');
+	}
+}

database/migrations/2025_01_25_205853_create_user_groups_table.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 LycheeOrg.
+ */
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class() extends Migration {
+	/**
+	 * Run the migrations.
+	 */
+	public function up(): void
+	{
+		Schema::create('user_groups', function (Blueprint $table) {
+			$table->increments('id');
+			$table->string('name', 100)->nullable(false)->unique();
+			$table->dateTime('created_at', 6)->nullable(false);
+			$table->dateTime('updated_at', 6)->nullable(false);
+			$table->index('id');
+		});
+	}
+
+	/**
+	 * Reverse the migrations.
+	 */
+	public function down(): void
+	{
+		Schema::dropIfExists('user_groups');
+	}
+};

database/migrations/2025_01_25_210236_create_users_user_groups.php

@@ -0,0 +1,44 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 LycheeOrg.
+ */
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class() extends Migration {
+	private const USER_ID = 'user_id';
+	private const USER_GROUP_ID = 'user_group_id';
+
+	/**
+	 * Run the migrations.
+	 */
+	public function up(): void
+	{
+		Schema::create('users_user_groups', function (Blueprint $table) {
+			$table->increments('id');
+			$table->unsignedInteger(self::USER_ID)->nullable(false);
+			$table->unsignedInteger(self::USER_GROUP_ID)->nullable(false);
+			$table->dateTime('created_at', 6)->nullable(false);
+
+			$table->index([self::USER_ID]);
+			$table->index([self::USER_GROUP_ID]);
+			$table->index([self::USER_ID, self::USER_GROUP_ID]);
+			$table->unique([self::USER_ID, self::USER_GROUP_ID]);
+			$table->foreign(self::USER_ID)->references('id')->on('users')->cascadeOnUpdate()->cascadeOnDelete();
+			$table->foreign(self::USER_GROUP_ID)->references('id')->on('user_groups')->cascadeOnUpdate()->cascadeOnDelete();
+		});
+	}
+
+	/**
+	 * Reverse the migrations.
+	 */
+	public function down(): void
+	{
+		Schema::dropIfExists('users_user_groups');
+	}
+};

database/migrations/2025_01_25_210255_update_access_permissions_with_groups.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * SPDX-License-Identifier: MIT
+ * Copyright (c) 2017-2018 Tobias Reich
+ * Copyright (c) 2018-2025 LycheeOrg.
+ */
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class() extends Migration {
+	private const USER_GROUP_ID = 'user_group_id';
+
+	/**
+	 * Run the migrations.
+	 */
+	public function up(): void
+	{
+		Schema::table('access_permissions', function ($table) {
+			$table->unsignedInteger(self::USER_GROUP_ID)->nullable()->default(null)->after('user_id');
+		});
+	}
+
+	/**
+	 * Reverse the migrations.
+	 */
+	public function down(): void
+	{
+		Schema::table('access_permissions', function (Blueprint $table) {
+			$table->dropColumn(self::USER_GROUP_ID);
+		});
+	}
+};