commit

Author: freekmurze

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All Notable changes to `laravel-permission` will be documented in this file
 
+## unreleased
+
+- add `getDirectPermissions`, `getPermissionsViaRoles`, `getAllPermissions`
+
 ## 1.10.0 - 2017-02-22
 
 - add `hasAnyPermission`

README.md

@@ -324,17 +324,19 @@ In above example a role is given permission to edit articles and this role is as
 
 This method is useful if one has a form for setting permissions for roles and users in his application and want to restrict to change inherited permissions of roles of user, i.e. allowing to change only direct permissions of user.
 
-You can also list all of theses permissions:
+You can  list all of theses permissions:
+
 ```php
 //direct permissions
-$user->permissions
+$user->getDirectPermissions() // or $user->permissions;
 
 //permissions inherited from user's roles
-$user->permissions_via_roles
+$user->getPermissionsViaRoles();
 
 //all permissions which apply on the user
-$user->all_permissions
+$user->getAllPermissions();
 ```
+
 All theses responses are collections of `Spatie\Permission\Models\Permission`-objects.
 
 If we follow the previous example, the first response will be a collection with the 'delete article' permission, the second will be a collection with the 'edit article' permission and the third will contain both.

src/Traits/HasRoles.php

@@ -279,11 +279,21 @@ protected function getStoredRole($role)
     }
 
     /**
-     * Return all the permissions the user have via his roles.
+     * Return all  permissions the directory coupled to the user.
      *
-     * @return Collection
+     * @return \Illuminate\Support\Collection
      */
-    protected function getPermissionsViaRolesAttribute()
+    public function getDirectPermissions()
+    {
+        return $this->permissions;
+    }
+
+    /**
+     * Return all the permissions the user has via roles.
+     *
+     * @return \Illuminate\Support\Collection
+     */
+    public function getPermissionsViaRoles()
     {
         return $this->load('roles', 'roles.permissions')
             ->roles->flatMap(function ($role) {
@@ -292,12 +302,12 @@ protected function getPermissionsViaRolesAttribute()
     }
 
     /**
-     * Return all the permissions the user have (directly and via his roles).
+     * Return all the permissions the user has, both directly and via roles.
      *
-     * @return Collection
+     * @return \Illuminate\Support\Collection
      */
-    protected function getAllPermissionsAttribute()
+    public function getAllPermissions()
     {
-        return $this->permissions->merge($this->permissions_via_roles)->sort()->values();
+        return $this->permissions->merge($this->getPermissionsViaRoles())->sort()->values();
     }
 }

tests/HasRolesTest.php

@@ -394,7 +394,7 @@ public function it_can_determine_that_user_has_direct_permission()
     }
 
     /** @test */
-    public function it_can_determine_that_user_can_list_all_the_permissions_he_has_via_his_roles()
+    public function it_can_list_all_the_permissions_via_his_roles()
     {
         $roleModel = app(Role::class);
         $roleModel->findByName('testRole2')->givePermissionTo('edit-news');
@@ -404,12 +404,12 @@ public function it_can_determine_that_user_can_list_all_the_permissions_he_has_v
 
         $this->assertEquals(
             collect(['edit-articles', 'edit-news']),
-            $this->testUser->permissions_via_roles->pluck('name')
+            $this->testUser->getPermissionsViaRoles()->pluck('name')
         );
     }
 
     /** @test */
-    public function it_can_determine_that_user_can_list_all_his_permissions()
+    public function it_can_list_all_the_coupled_permissions_both_directly_and_via_roles()
     {
         $this->testUser->givePermissionTo('edit-news');
 
@@ -418,7 +418,7 @@ public function it_can_determine_that_user_can_list_all_his_permissions()
 
         $this->assertEquals(
             collect(['edit-articles', 'edit-news']),
-            $this->testUser->all_permissions->pluck('name')
+            $this->testUser->getAllPermissions()->pluck('name')
         );
     }