Merge pull request #5 from fintechbd/LP-26-Permission-Pagination

LP-26 permission pagination

config/auth.php

@@ -139,5 +139,6 @@
     |
     | This value will be used to across system where model is needed
     */
-    'middleware' => ['auth:sanctum'],
+    //    'middleware' => ['auth:sanctum'],
+    'middleware' => [],
 ];

database/migrations/2023_09_28_224955_create_permission_tables.php

@@ -28,23 +28,34 @@ public function up()
         }
 
         Schema::create($tableNames['permissions'], function (Blueprint $table) {
-            $table->bigIncrements('id'); // permission id
+            $table->id(); // permission id
             $table->string('name');       // For MySQL 8.0 use string('name', 125);
             $table->string('guard_name'); // For MySQL 8.0 use string('guard_name', 125);
+            $table->foreignId('creator_id')->nullable();
+            $table->foreignId('editor_id')->nullable();
+            $table->foreignId('destroyer_id')->nullable();
+            $table->foreignId('restorer_id')->nullable();
             $table->timestamps();
-
+            $table->softDeletes();
+            $table->timestamp('restored_at')->nullable();
             $table->unique(['name', 'guard_name']);
         });
 
         Schema::create($tableNames['roles'], function (Blueprint $table) use ($teams, $columnNames) {
-            $table->bigIncrements('id'); // role id
+            $table->id(); // role id
             if ($teams || config('permission.testing')) { // permission.testing is a fix for sqlite testing
                 $table->unsignedBigInteger($columnNames['team_foreign_key'])->nullable();
                 $table->index($columnNames['team_foreign_key'], 'roles_team_foreign_key_index');
             }
             $table->string('name');       // For MySQL 8.0 use string('name', 125);
             $table->string('guard_name'); // For MySQL 8.0 use string('guard_name', 125);
+            $table->foreignId('creator_id')->nullable();
+            $table->foreignId('editor_id')->nullable();
+            $table->foreignId('destroyer_id')->nullable();
+            $table->foreignId('restorer_id')->nullable();
             $table->timestamps();
+            $table->softDeletes();
+            $table->timestamp('restored_at')->nullable();
             if ($teams || config('permission.testing')) {
                 $table->unique([$columnNames['team_foreign_key'], 'name', 'guard_name']);
             } else {
@@ -57,6 +68,7 @@ public function up()
 
             $table->string('model_type');
             $table->unsignedBigInteger($columnNames['model_morph_key']);
+            $table->timestamps();
             $table->index([$columnNames['model_morph_key'], 'model_type'], 'model_has_permissions_model_id_model_type_index');
 
             $table->foreign(PermissionRegistrar::$pivotPermission)
@@ -102,6 +114,7 @@ public function up()
         Schema::create($tableNames['role_has_permissions'], function (Blueprint $table) use ($tableNames) {
             $table->unsignedBigInteger(PermissionRegistrar::$pivotPermission);
             $table->unsignedBigInteger(PermissionRegistrar::$pivotRole);
+            $table->timestamps();
 
             $table->foreign(PermissionRegistrar::$pivotPermission)
                 ->references('id') // permission id

database/migrations/2023_09_28_230630_create_teams_table.php

@@ -31,8 +31,8 @@ public function up(): void
 
         Schema::create('teams', function (Blueprint $table) {
             $table->id();
-            $table->json('name')->nullable();
-            $table->json('teams_data')->nullable();
+            $table->string('name');
+            $table->text('description')->nullable();
             $table->foreignId('creator_id')->nullable();
             $table->foreignId('editor_id')->nullable();
             $table->foreignId('destroyer_id')->nullable();

routes/api.php

@@ -51,7 +51,7 @@
     Route::middleware(config('fintech.auth.middleware'))->group(function () {
         Route::apiResource('users', \Fintech\Auth\Http\Controllers\UserController::class);
         //        Route::apiResource('roles', \Fintech\Auth\Http\Controllers\RoleController::class);
-        //        Route::apiResource('permissions', \Fintech\Auth\Http\Resources\PermissionCollection::class);
+        Route::apiResource('permissions', \Fintech\Auth\Http\Controllers\PermissionController::class);
         //        Route::apiResource('teams', \Fintech\Auth\Http\Controllers\TeamController::class);
         Route::apiSingleton('users.profile', \Fintech\Auth\Http\Controllers\ProfileController::class);
     });

src/Http/Controllers/PermissionController.php

@@ -2,6 +2,7 @@
 
 namespace Fintech\Auth\Http\Controllers;
 
+use Fintech\Auth\Facades\Auth;
 use Fintech\Auth\Http\Requests\ImportPermissionRequest;
 use Fintech\Auth\Http\Requests\IndexPermissionRequest;
 use Fintech\Auth\Http\Requests\StorePermissionRequest;
@@ -30,14 +31,6 @@ class PermissionController extends Controller
 {
     use ApiResponseTrait;
 
-    /**
-     * PermissionController constructor.
-     */
-    public function __construct()
-    {
-
-    }
-
     /**
      * @lrd:start
      * Return a listing of the permission resource as collection.
@@ -51,7 +44,7 @@ public function index(IndexPermissionRequest $request): PermissionCollection|Jso
         try {
             $inputs = $request->validated();
 
-            $permissionPaginate = \Auth::permission()->list($inputs);
+            $permissionPaginate = Auth::permission()->list($inputs);
 
             return new PermissionCollection($permissionPaginate);
 
@@ -74,7 +67,7 @@ public function store(StorePermissionRequest $request): JsonResponse
         try {
             $inputs = $request->validated();
 
-            $permission = \Auth::permission()->create($inputs);
+            $permission = Auth::permission()->create($inputs);
 
             if (! $permission) {
                 throw new StoreOperationException();
@@ -103,7 +96,7 @@ public function show(string|int $id): PermissionResource|JsonResponse
     {
         try {
 
-            $permission = \Auth::permission()->read($id);
+            $permission = Auth::permission()->read($id);
 
             if (! $permission) {
                 throw new ResourceNotFoundException(__('core::messages.resource.notfound', ['model' => 'Permission', 'id' => strval($id)]));
@@ -134,15 +127,15 @@ public function update(UpdatePermissionRequest $request, string|int $id): JsonRe
     {
         try {
 
-            $permission = \Auth::permission()->read($id);
+            $permission = Auth::permission()->read($id);
 
             if (! $permission) {
                 throw new ResourceNotFoundException(__('core::messages.resource.notfound', ['model' => 'Permission', 'id' => strval($id)]));
             }
 
             $inputs = $request->validated();
 
-            if (! \Auth::permission()->update($id, $inputs)) {
+            if (! Auth::permission()->update($id, $inputs)) {
 
                 throw new UpdateOperationException();
             }
@@ -174,13 +167,13 @@ public function destroy(string|int $id)
     {
         try {
 
-            $permission = \Auth::permission()->read($id);
+            $permission = Auth::permission()->read($id);
 
             if (! $permission) {
                 throw new ResourceNotFoundException(__('core::messages.resource.notfound', ['model' => 'Permission', 'id' => strval($id)]));
             }
 
-            if (! \Auth::permission()->destroy($id)) {
+            if (! Auth::permission()->destroy($id)) {
 
                 throw new DeleteOperationException();
             }
@@ -210,13 +203,13 @@ public function restore(string|int $id)
     {
         try {
 
-            $permission = \Auth::permission()->read($id, true);
+            $permission = Auth::permission()->read($id, true);
 
             if (! $permission) {
                 throw new ResourceNotFoundException(__('core::messages.resource.notfound', ['model' => 'Permission', 'id' => strval($id)]));
             }
 
-            if (! \Auth::permission()->restore($id)) {
+            if (! Auth::permission()->restore($id)) {
 
                 throw new RestoreOperationException();
             }
@@ -245,7 +238,7 @@ public function export(IndexPermissionRequest $request): JsonResponse
         try {
             $inputs = $request->validated();
 
-            $permissionPaginate = \Auth::permission()->export($inputs);
+            $permissionPaginate = Auth::permission()->export($inputs);
 
             return $this->exported(__('core::messages.resource.exported', ['model' => 'Permission']));
 
@@ -269,7 +262,7 @@ public function import(ImportPermissionRequest $request): JsonResponse
         try {
             $inputs = $request->validated();
 
-            $permissionPaginate = \Auth::permission()->list($inputs);
+            $permissionPaginate = Auth::permission()->list($inputs);
 
             return new PermissionCollection($permissionPaginate);
 

src/Http/Requests/StorePermissionRequest.php

@@ -3,6 +3,7 @@
 namespace Fintech\Auth\Http\Requests;
 
 use Illuminate\Foundation\Http\FormRequest;
+use Illuminate\Validation\Rule;
 
 class StorePermissionRequest extends FormRequest
 {
@@ -22,31 +23,8 @@ public function authorize(): bool
     public function rules(): array
     {
         return [
-            //
-        ];
-    }
-
-    /**
-     * Get the validation attributes that apply to the request.
-     *
-     * @return array
-     */
-    public function attributes()
-    {
-        return [
-            //
-        ];
-    }
-
-    /**
-     * Get the validation messages that apply to the request.
-     *
-     * @return array
-     */
-    public function messages()
-    {
-        return [
-            //
+            'name' => ['required', 'string', 'min:5', 'max:255'],
+            'guard_name' => ['required', 'string', Rule::in(array_keys(config('auth.guards', ['web', 'api'])))],
         ];
     }
 }

src/Models/Permission.php

@@ -21,12 +21,12 @@ class Permission extends Model implements Auditable
 
     protected $primaryKey = 'id';
 
-    protected $fillable = [];
-
     protected $guarded = ['id'];
 
     protected $casts = [];
 
+    protected $hidden = ['creator_id', 'editor_id', 'destroyer_id', 'restorer_id', 'deleted_at', 'restored_at'];
+
     /*
     |--------------------------------------------------------------------------
     | FUNCTIONS

src/Models/Role.php

@@ -21,12 +21,12 @@ class Role extends Model implements Auditable
 
     protected $primaryKey = 'id';
 
-    protected $fillable = [];
-
     protected $guarded = ['id'];
 
     protected $casts = [];
 
+    protected $hidden = ['creator_id', 'editor_id', 'destroyer_id', 'restorer_id', 'deleted_at', 'restored_at'];
+
     /*
     |--------------------------------------------------------------------------
     | FUNCTIONS

src/Models/Team.php

@@ -21,12 +21,12 @@ class Team extends Model implements Auditable
 
     protected $primaryKey = 'id';
 
-    protected $fillable = [];
-
     protected $guarded = ['id'];
 
     protected $casts = [];
 
+    protected $hidden = ['creator_id', 'editor_id', 'destroyer_id', 'restorer_id', 'deleted_at', 'restored_at'];
+
     /*
     |--------------------------------------------------------------------------
     | FUNCTIONS

src/Models/User.php

@@ -25,8 +25,6 @@ class User extends Authenticatable implements Auditable
 
     protected $primaryKey = 'id';
 
-    protected $fillable = [];
-
     protected $guarded = ['id'];
 
     protected $casts = [
@@ -40,6 +38,8 @@ class User extends Authenticatable implements Auditable
         'wrong_pin' => 0,
     ];
 
+    protected $hidden = ['creator_id', 'editor_id', 'destroyer_id', 'restorer_id', 'deleted_at', 'restored_at'];
+
     /*
     |--------------------------------------------------------------------------
     | FUNCTIONS

src/Repositories/Eloquent/PermissionRepository.php

@@ -4,7 +4,9 @@
 
 use Fintech\Auth\Exceptions\PermissionRepositoryException;
 use Fintech\Auth\Interfaces\PermissionRepository as InterfacesPermissionRepository;
+use Illuminate\Contracts\Database\Eloquent\Builder;
 use Illuminate\Contracts\Pagination\LengthAwarePaginator;
+use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Eloquent\Model;
 use InvalidArgumentException;
 
@@ -36,6 +38,11 @@ public function list(array $filters = [])
     {
         $query = $this->model->newQuery();
 
+        if (isset($filters['search']) && ! empty($filters['search'])) {
+            $query->where('name', 'like', "%{$filters['search']}%")
+                ->orWhere('guard_name', 'like', "%{$filters['search']}%");
+        }
+
         //Handle Sorting
         $query->orderBy($filters['sort'] ?? $this->model->getKeyName(), $filters['direction'] ?? 'asc');