permission array sorted, permission append method added

Author: Nur Alam

src/Contracts/WithPermissionGenerator.php

@@ -21,4 +21,11 @@ public function getPermissionTitle(): string;
      * @return array
      */
     public function getExcludeMethods(): array;
+
+    /**
+     * Append permission to another permission
+     *
+     * @return string
+     */
+    public function getAppendTo(): string;
 }

src/Permissions.php

@@ -104,9 +104,11 @@ protected function customPermissions(): Permissions
     protected function getCachedPermissions()
     {
         if (!$this->hasCachedPermissions()) {
+            ksort($this->permissions);
+
             return $this->permissions;
         }
-
+        
         return Cache::get(Constant::CACHE_PERMISSIONS);
     }
 

src/Services/RoutePermissionGenerator.php

@@ -80,10 +80,7 @@ public function generate()
                 continue;
             }
 
-            // permission group title
-            $title = $this->generatePermissionTitle($controllerInstance);
-
-            $key = strtolower(Str::slug($title, "-"));
+            $key = $this->generateKey($controllerInstance);
 
             $permissions[$key][] = [
                 'name' => $routeName, // permission name
@@ -101,6 +98,39 @@ public function generate()
         ];
     }
 
+    protected function generateKey($controllerInstance)
+    {
+        $key = $this->appendPermissionKey($controllerInstance);
+
+        if (empty($key)) {
+            $title = $this->generatePermissionTitle($controllerInstance);
+
+            return strtolower(Str::slug($title, "-"));
+        }
+
+        return $key;
+    }
+
+    protected function appendPermissionKey($currentControllerInstance)
+    {
+        if ($currentControllerInstance instanceof WithPermissionGenerator) {
+            $appendTo = $currentControllerInstance->getAppendTo();
+
+            // generate key
+            if (!empty($appendTo) && class_exists($appendTo)) {
+                $appendControllerClass = app("\\" . $appendTo);
+
+                $title = $this->generatePermissionTitle($appendControllerClass);
+
+                return strtolower(Str::slug($title, "-"));
+            }
+
+            return $appendTo;
+        }
+
+        return '';
+    }
+
     protected function generatePermissionTitle($controllerInstance)
     {
         // if the controller use the WithPermissible interface then get the title

src/Traits/PermissionGenerator.php

@@ -10,36 +10,55 @@ trait PermissionGenerator
 
     private $excludeMethods = [];
 
+    private $appendTo = '';
+
     /**
      * Set the permission group title
      *
      * @param  string  $title
      *
      * @return $this
      */
-    protected function permissionGroupTitle(string $title){
+    protected function permissionGroupTitle(string $title)
+    {
         $this->title = $title;
 
         return $this;
     }
 
     /**
-     * Set excluded routes by controller method
+     * Excluded routes by controller method, 
+     * so that it can not generate as permission name 
      *
      * @param ...$methods
      *
      * @return $this
      */
-    protected function permissionExcludeMethods(...$methods){
+    protected function permissionExcludeMethods(...$methods)
+    {
         $this->excludeMethods = $methods;
 
         return $this;
     }
 
+    /**
+     * Permission names append to another permission group
+     *
+     * @param string $key // SomeController::class | permission-group-key
+     * @return void
+     */
+    protected function permissionAppendTo(string $key)
+    {
+        $this->appendTo = $key;
+
+        return $this;
+    }
+
     /**
      * @return string
      */
-    public function getPermissionTitle(): string{
+    public function getPermissionTitle(): string
+    {
         return $this->title;
     }
 
@@ -50,4 +69,12 @@ public function getExcludeMethods(): array
     {
         return $this->excludeMethods;
     }
-}
+
+    /**
+     * @return string
+     */
+    public function getAppendTo(): string
+    {
+        return $this->appendTo;
+    }
+}