section permission method refactored

Author: Nur Alam

README.md

@@ -228,8 +228,9 @@ From which controller's routes permission names will be generate, define it here
  */
 'permission-generate-controllers' => [
     'App\Http\Controllers',
-    // 'App\Http\Controllers\Api',
 
+    // sample
+    // 'App\Http\Controllers\Api',
     // App\Http\Controllers\DepartmentController::class,
     // App\Http\Controllers\DesignationController::class,
 ],
@@ -243,6 +244,8 @@ Exclude routes by defining controller namespace. Here auth and EmployeeProfileCo
  */
 'exclude-controllers'           => [
     'App\Http\Controllers\Auth', // exclude routes of all auth controllers
+
+    // sample
     App\Http\Controller\Employee\EmployeeProfileController::class, // exclude routes of EmployeeProfileController
 ],
 ```
@@ -254,6 +257,7 @@ Exclude routes by defining controller namespace. Here auth and EmployeeProfileCo
  * Exclude routes by route name
  */
 'exclude-routes'                => [
+    // sample
     'register.user',
     'employee.profile',
     ....
@@ -269,6 +273,42 @@ Caching the permission names
  */
 'cache-permissions'             => true,
 ```
+### 7. Permissions Section
+Permissions can be organised by section, example admin section, employee section, settings setion etc.
+```php
+/**
+ * Parmissions can be organised by section (ex: adminland, settings, employee managment etc)
+ * 
+ * sample format: key as section name, value as generated permissions-title
+ * [
+ *   'adminland' => [
+ *       'employee-permissions',
+ *       'bonus-permissions'
+ *   ],
+ *   'settings' => [
+ *       'office-permissions',
+ *       'designation-permissions',
+ *       'email-settings-permissions',
+ *       'rules-permissions'
+ *   ],
+ *  ]
+ */
+'permissions-section' => [
+    // sample
+    'admin' => [
+        'users-permissions',
+        'roles-permissions'
+    ],
+    'settings' => [
+        'email-settings-permissions',
+        RuleController::class, // if permission is from routes
+        NotificationController::class // if permission is from routes
+    ],
+    ......,
+    ......,
+]
+```
+
 ## Alternatively generate Permissions
 The package allows you to generate permission names by defining resource names.
 

config/permission-generator.php

@@ -66,7 +66,7 @@
     /**
      * Parmissions can be organised by section (ex: adminland, settings, employee managment etc)
      * 
-     * format: key as section name, value as generated permissions-title
+     * sample format: key as section name, value as generated permissions-title
      * [
      *   'adminland' => [
      *       'employee-permissions',
@@ -75,8 +75,8 @@
      *   'settings' => [
      *       'office-permissions',
      *       'designation-permissions',
-     *       'email-settings-permissions,
-     *       'rules-permissions
+     *       'email-settings-permissions',
+     *       'rules-permissions'
      *   ],
      *  ]
      */

src/Permissions.php

@@ -63,10 +63,6 @@ public function fromRoutes()
     public function get(): array
     {
         if (!$this->hasCachedPermissions()) {
-            ksort($this->permissions);
-
-            $this->sectionPermissions(); // if any
-
             return $this->permissions;
         }
 
@@ -108,32 +104,6 @@ protected function customPermissions(): Permissions
         return $this;
     }
 
-    protected function sectionPermissions()
-    {
-        $permissionsSection = config('permission-generator.permissions-section');
-
-        if (empty($permissionsSection)) {
-            return $this;
-        }
-
-        $sectionWisePermissions = [];
-
-        foreach ($permissionsSection as $section => $permissions) {
-            foreach ($permissions as $permission) {
-                $sectionWisePermissions[$section]['section'] = str_replace(['\'', '/', '"', ',', ';', '<', '>', '.', '_', '-', ':'], ' ', $section);
-                $sectionWisePermissions[$section]['permissions'][$permission] = $this->permissions[$permission];
-
-                unset($this->permissions[$permission]);
-            }
-
-            ksort($sectionWisePermissions[$section]['permissions']);
-        }
-
-        $this->permissions = array_merge($sectionWisePermissions, $this->permissions);
-
-        return $this;
-    }
-
     protected function hasCachedPermissions(): bool
     {
         return config('permission-generator.cache-permissions')

src/Services/ResourcePermissionGenerator.php

@@ -54,9 +54,41 @@ public function generate()
             }
         }
 
+        ksort($resourcePermissions);
+
         return [
-            'permissions' => $resourcePermissions,
+            'permissions' => $this->sectionPermissions($resourcePermissions),
             'only_permission_names' => $onlyPermissionNames
         ];
     }
+
+    protected function sectionPermissions($generatedPermissions)
+    {
+        $permissionsSection = config('permission-generator.permissions-section');
+
+        if (empty($permissionsSection)) {
+            return $generatedPermissions;
+        }
+
+        $sectionWisePermissions = [];
+
+        foreach ($permissionsSection as $section => $permissions) {
+            foreach ($permissions as $permissionsTitleKey) {
+                if (array_key_exists($permissionsTitleKey, $generatedPermissions)) {
+                    $sectionWisePermissions[$section]['section'] = str_replace(['\'', '/', '"', ',', ';', '<', '>', '.', '_', '-', ':'], ' ', $section);
+                    $sectionWisePermissions[$section]['permissions'][$permissionsTitleKey] = $generatedPermissions[$permissionsTitleKey];
+
+                    unset($generatedPermissions[$permissionsTitleKey]);
+                }
+            }
+
+            if (!empty($sectionWisePermissions)) {
+                ksort($sectionWisePermissions[$section]['permissions']);
+            }
+        }
+
+        $generatedPermissions = array_merge($sectionWisePermissions, $generatedPermissions);
+
+        return $generatedPermissions;
+    }
 }

src/Services/RoutePermissionGenerator.php

@@ -84,13 +84,54 @@ public function generate()
 
             $onlyPermissionNames[] = $routeName;
         }
-        
+
+        ksort($permissions);
+
         return [
-            'permissions' => $permissions,
+            'permissions' => $this->sectionPermissions($permissions),
             'only_permission_names' => $onlyPermissionNames
         ];
     }
 
+    protected function sectionPermissions($generatedPermissions)
+    {
+        $permissionsSection = config('permission-generator.permissions-section');
+
+        if (empty($permissionsSection)) {
+            return $generatedPermissions;
+        }
+
+        $sectionWisePermissions = [];
+
+        foreach ($permissionsSection as $section => $permissions) {
+            foreach ($permissions as $permissionsTitle) {
+                // check is the permissions title is key or class
+                if (class_exists($permissionsTitle)) {
+                    $permissionsTitleClassInstance = app("\\" . $permissionsTitle);
+
+                    $title = $this->generatePermissionTitle($permissionsTitleClassInstance);
+
+                    $permissionsTitle = strtolower(Str::slug($title, "-"));
+                }
+
+                if (array_key_exists($permissionsTitle, $generatedPermissions)) {
+                    $sectionWisePermissions[$section]['section'] = str_replace(['\'', '/', '"', ',', ';', '<', '>', '.', '_', '-', ':'], ' ', $section);
+                    $sectionWisePermissions[$section]['permissions'][$permissionsTitle] = $generatedPermissions[$permissionsTitle];
+
+                    unset($generatedPermissions[$permissionsTitle]);
+                }
+            }
+
+            if (!empty($sectionWisePermissions)) {
+                ksort($sectionWisePermissions[$section]['permissions']);
+            }
+        }
+
+        $generatedPermissions = array_merge($sectionWisePermissions, $generatedPermissions);
+
+        return $generatedPermissions;
+    }
+
     protected function generateKey($controllerInstance)
     {
         $key = $this->appendPermissionKey($controllerInstance);