Merge pull request mateusjunges#125 from mateusjunges/mateusjunges#124

Fixes mateusjunges#124

Author: Mateus Junges

CHANGELOG.md

@@ -1,19 +1,34 @@
 # Changelog
 
 All notable changes to `mateusjunges/laravel-acl` will be documented in this file.
+## 2.0.2
+#### In [UsersTrait.php](https://github.com/jungessolutions/laravel-acl/blob/master/src/Traits/UsersTrait.php):
+- Add option to use array as parameter for `syncPermissions()` method;
+- Add option to use array as parameter for `assignPermissions()` method;
+- Add option to use array as parameter for `assignGroup()` method;
+- Add option to use array as parameter for `revokePermissions()` method;
+- Add option to use array as parameter for `assignGroup()` method;
+- Add option to use array as parameter for `revokeGroup()` method;
+
+#### In [GroupsTrait.php](https://github.com/mateusjunges/laravel-acl/blob/master/src/Traits/GroupsTrait.php):
+- Add option to use array as parameter for `syncPermissions()` method;
+- Add option to use array as parameter for `assignPermissions()` method;
+- Add option to use array as parameter for `revokePermissions()` method;
+- Add option to use array as parameter for `assignUser()` method;
+- Add option to use array as parameter for `removeUser()` method;
 
 ## 2.0.1
 - Update composer.json for laravel 6.0
 
 ## 2.0.0
 #### In [UsersTrait.php](https://github.com/jungessolutions/laravel-acl/blob/master/src/Traits/UsersTrait.php):
-- `hasAnyPermissions()`, `assignPermissions()`, `syncPermissions`, `revokePermissions()`,
+- `hasAnyPermissions()`, `assignPermissions()`, `syncPermissions()`, `revokePermissions()`,
 `assignGroup()`, `revokeGroup`, `hasAnyGroup()`, `hasAllGroups()` and `hasAllPermissions()`
 methods now works with non array params. You can [read the docs here](https://github.com/jungessolutions/laravel-acl#checking-for-permissions);
 
 - Added eager loading for permissions checks.
 
-#### In [GroupsTrait.php]():
+#### In [GroupsTrait.php](https://github.com/mateusjunges/laravel-acl/blob/master/src/Traits/GroupsTrait.php):
 - `assignPermissions()`, `syncPermissions()`, `revokePermissions()`,
 `assignUser()`, `removeUser()`, `hasAnyPermissions()` and `hasAllPermissions()`
 methods now works with non array params. You can [read the docs here](https://github.com/jungessolutions/laravel-acl#checking-for-permissions);  

README.md

@@ -199,14 +199,26 @@ one instance of permission model and a permission slug too.
 //With permission slugs:
 $user->assignPermissions('permission-slug-1', 'permission-slug-2');
 
+//Using arrays:
+$user->assignPermissions(['permission-slug-1', 'permission-slug-2']);
+
 //With permission ids:
 $user->assignPermissions(1, 2, 3);
 
+//Using arrays:
+$user->assignPermissions([1, 2, 3]);
+
 //With instances of permission model:
 $user->assignPermissions(Permission::find(1), Permission::find(2));
 
+//Using arrays:
+$user->assignPermissions([Permission::find(1), Permission::find(2)]);
+
 //With the three ways above combined:
 $user->assignPermissions(1, 'permission-slug', Permission::find(1));
+
+//Using arrays:
+$user->assignPermissions([1, 'permission-slug', Permission::find(1)]);
 ```
 Like as add permissions to user, you can add permissions to groups.
 To do this, you have the same method, and they can be used by the same way:
@@ -215,14 +227,26 @@ To do this, you have the same method, and they can be used by the same way:
 //With permission slugs:
 $group->assignPermissions('permission-slug-1', 'permission-slug-2');
 
+//Using arrays:
+$group->assignPermissions(['permission-slug-1', 'permission-slug-2']);
+
 //With permission ids:
 $group->assignPermissions(1, 2, 3);
 
+//Using arrays:
+$group->assignPermissions([1, 2, 3]);
+
 //With instances of permission model:
 $group->assignPermissions(Permission::find(1), Permission::find(2));
 
+//Using arrays:
+$group->assignPermissions([Permission::find(1), Permission::find(2)]);
+
 //With the three ways above combined:
 $group->assignPermissions(1, 'permission-slug', Permission::find(1));
+
+//Using arrays:
+$group->assignPermissions([1, 'permission-slug', Permission::find(1)]);
 ```
 
 After add permissions to a group, you may want/need to add a user to a group.
@@ -234,36 +258,63 @@ You can add a group to a user, and use 4 different types of parameters:
 //Assign a group to a user, using group slugs:
 $user->assignGroup('group-slug-1', 'group-slug-2');
 
+//Using arrays: 
+$user->assignGroup(['group-slug-1', 'group-slug-2']);
+
 //Assign a group to a user, using group ids:
 $user->assignGroup(1, 2, 3);
 
+//Using arrays:
+$user->assignGroup([1, 2, 3]);
+
 //Assign a group to a user, with instance of group models:
 $user->assignGroup(Group::find(1), Group::find(2));
 
+//Using arrays:
+$user->assignGroup([Group::find(1), Group::find(2)]);
+
 //Assign group to a user, combining the three methods above:
 $user->assignGroup(Group::find(1), 'group-slug-2', 3);
+
+//Usign arrays:
+$user->assignGroup([Group::find(1), 'group-slug-2', 3]);
 ```
 #### Second way:
 You can add a user to a group, and use 4 different types of parameters:
 ```php
 //Assign a user to a group, with user names:
 $group->assignUser('User one', 'User two');
 
+//Using arrays:
+$group->assignUser(['User one', 'User two']);
+
 //Assign a user to a group, user ids:
 $group->assignUser(1, 2, 3);
 
+//Using arrays:
+$group->assignUser([1, 2, 3]);
+
 //Assign a user to a group, with instance of User models:
 $group->assignUser(User::find(1), User::find(2));
 
+//Using arrays:
+$group->assignUser([User::find(1), User::find(2)]);
+
 //Assign a user to a group combining the three methods above:
 $group->assignUser(User::find(1), 'User name', 3);
+
+//Using arrays:
+$group->assignUser([User::find(1), 'User name', 3]);
 ```
 
 ### Revoke permissions
 #### 1 - Revoke permissions from user
 You can revoke a user permission using the method below:
 ```php
 $user->revokePermissions('permission-slug', 2, Permission::find(3));
+
+//Or with arrays:
+$user->revokePermissions(['permission-slug', 2, Permission::find(3)]);
 ```
 Like the methods to add or remove a group from a user, you can use as function parameter a
 the permission ids, permission slugs, instance of permission model, or,
@@ -273,6 +324,9 @@ combine these three ways.
 You can revoke a group permission using the method below:
 ```php
 $group->revokePermissions('permission-slug', 2, Permission::find(3));
+
+//Or with arrays:
+$group->revokePermissions(['permission-slug', 2, Permission::find(3)]);
 ```
 Like the methods to add or remove a group from a user, you can use as function parameter 
 the permission ids, permission slugs, instance of permission model, or,
@@ -283,6 +337,10 @@ You can remove a group from the user by using one of these methods:
 ```php
 $user->revokeGroup('permission-slug', 2, Permission::find(3));
 $group->removeUser('User name', 2, User::find(3));
+
+//Or with arrays:
+$user->revokeGroup(['permission-slug', 2, Permission::find(3)]);
+$group->removeUser(['User name', 2, User::find(3)]);
 ```
 Like the methods to add or remove a group from a user, you can use as function parameter a
  group/user ids, group/user slugs, instance of group/user model , or,
@@ -399,14 +457,26 @@ The user permissions can synced with this method:
 //With permission id:
 $user->syncPermissions(1, 2, 4);
 
+//Using array:
+$user->syncPermissions([1, 2, 4]);
+
 //With permission slugs:
 $user->syncPermissions('permission-slug-1', 'permission-slug-2');
 
+//Using arrays:
+$user->syncPermissions(['permission-slug-1', 'permission-slug-2']);
+
 //With instance of permission model:
 $user->syncPermissions(Permission::find(1), Permission::find(2));
 
+//Using arrays:
+$user->syncPermissions([Permission::find(1), Permission::find(2)]);
+
 //Combining the three ways:
 $user->syncPermissions(1, 'permission-slug', Permission::find(3));
+
+//Using arrays:
+$user->syncPermissions([1, 'permission-slug', Permission::find(3)]);
 ```
 
 ## Syncing group permissions
@@ -415,14 +485,26 @@ The groups permissions can synced with this method:
 //With permission id:
 $group->syncPermissions(1, 2, 4);
 
+//Usign arrays:
+$group->syncPermissions([1, 2, 4]);
+
 //With permission slugs:
 $group->syncPermissions('permission-slug-1', 'permission-slug-2');
 
+//Using arrays:
+$group->syncPermissions(['permission-slug-1', 'permission-slug-2']);
+
 //With instance of permission model:
 $group->syncPermissions(Permission::find(1), Permission::find(2));
 
+//Using arrays:
+$group->syncPermissions([Permission::find(1), Permission::find(2)]);
+
 //Combining the three ways:
 $group->syncPermissions(1, 'permission-slug', Permission::find(3));
+
+//Using arrays:
+$group->syncPermissions([1, 'permission-slug', Permission::find(3)]);
 ```
 
 ## Some "shortcuts"

src/Traits/GroupsTrait.php

@@ -66,6 +66,7 @@ public function users()
      */
     public function assignPermissions(...$permissions)
     {
+        $permissions = $this->getCorrectParameter($permissions);
         $permissions = $this->convertToPermissionIds($permissions);
         if ($permissions->count() == 0) {
             return false;
@@ -84,6 +85,7 @@ public function assignPermissions(...$permissions)
      */
     public function syncPermissions(...$permissions)
     {
+        $permissions = $this->getCorrectParameter($permissions);
         $permissions = $this->convertToPermissionIds($permissions);
         if ($permissions->count() == 0) {
             return false;
@@ -102,6 +104,7 @@ public function syncPermissions(...$permissions)
      */
     public function revokePermissions(...$permissions)
     {
+        $permissions = $this->getCorrectParameter($permissions);
         $permissions = $this->getPermissionIds($permissions);
         $this->permissions()->detach($permissions);
 
@@ -240,6 +243,7 @@ private function convertToUserId($users)
      */
     public function assignUser(...$users)
     {
+        $users = $this->getCorrectParameter($users);
         $users = $this->convertToUserId($users);
         if ($users->count() == 0) {
             return false;
@@ -258,6 +262,7 @@ public function assignUser(...$users)
      */
     public function removeUser(...$users)
     {
+        $users = $this->getCorrectParameter($users);
         $users = $this->getAllUsers($users);
         if ($users->count() == 0) {
             return false;
@@ -437,4 +442,18 @@ private function verifyColumns($table)
             ],
         ];
     }
+
+    /**
+     * Determine which type of parameter is being used.
+     * @param $param
+     * @return array
+     */
+    public function getCorrectParameter($param)
+    {
+        if (is_array($param[0])) {
+            return $param[0];
+        }
+
+        return $param;
+    }
 }

src/Traits/UsersTrait.php

@@ -299,6 +299,7 @@ private function convertToPermissionIds($permissions)
      */
     public function assignPermissions(...$permissions)
     {
+        $permissions = $this->getCorrectParameter($permissions);
         $permissions = $this->convertToPermissionIds($permissions);
         if ($permissions->count() == 0) {
             return false;
@@ -317,6 +318,7 @@ public function assignPermissions(...$permissions)
      */
     public function syncPermissions(...$permissions)
     {
+        $permissions = $this->getCorrectParameter($permissions);
         $permissions = $this->convertToPermissionIds($permissions);
         if ($permissions->count() == 0) {
             return false;
@@ -326,6 +328,20 @@ public function syncPermissions(...$permissions)
         return $this;
     }
 
+    /**
+     * Determine which type of parameter is being used.
+     * @param $param
+     * @return array
+     */
+    public function getCorrectParameter(array $param)
+    {
+        if (is_array($param[0])) {
+            return $param[0];
+        }
+
+        return $param;
+    }
+
     /**
      * Revoke permissions from the user.
      *
@@ -335,6 +351,7 @@ public function syncPermissions(...$permissions)
      */
     public function revokePermissions(...$permissions)
     {
+        $permissions = $this->getCorrectParameter($permissions);
         $permissions = $this->getPermissionIds($permissions);
         $this->permissions()->detach($permissions);
 
@@ -350,6 +367,7 @@ public function revokePermissions(...$permissions)
      */
     public function assignGroup(...$groups)
     {
+        $groups = $this->getCorrectParameter($groups);
         $groups = $this->convertToGroupIds($groups);
         if ($groups->count() == 0) {
             return false;
@@ -368,6 +386,7 @@ public function assignGroup(...$groups)
      */
     public function revokeGroup(...$groups)
     {
+        $groups = $this->getCorrectParameter($groups);
         $groups = $this->getGroupIds($groups);
         if ($groups->count() == 0) {
             return false;

tests/Traits/GroupUsersTest.php

@@ -35,4 +35,13 @@ public function test_if_a_user_can_be_attached_to_group_with_mixed_parameters()
             $this->testUser3->id
         ));
     }
+
+    public function test_if_a_user_can_be_attached_to_group_with_array_params()
+    {
+        $this->assertInstanceOf(Group::class, $this->testUserGroup->assignUser([
+            $this->testUser,
+            $this->testUser2->name,
+            $this->testUser3->id,
+        ]));
+    }
 }

tests/Traits/GroupsTrait/AssignPermissionsMethodTest.php

@@ -39,4 +39,15 @@ public function test_if_a_permission_can_be_assigned_to_group_with_permission_id
         self::assertTrue($this->testUserGroup->hasPermission($this->testUserPermission2));
         self::assertTrue($this->testUserGroup->hasPermission($this->testUserPermission3));
     }
+
+    public function test_it_can_assign_permissions_using_array_as_parameter()
+    {
+        $this->assertInstanceOf(Group::class, $this->testUserGroup->assignPermissions([
+           $this->testUserPermission->id,
+           $this->testUserPermission2->id,
+        ]));
+
+        self::assertTrue($this->testUserGroup->hasPermission($this->testUserPermission));
+        self::assertTrue($this->testUserGroup->hasPermission($this->testUserPermission2));
+    }
 }

tests/Traits/GroupsTrait/AssignUserMethodTest.php

@@ -39,4 +39,17 @@ public function test_if_a_user_can_be_attached_to_group_with_user_ids()
         self::assertTrue($this->testUser2->hasGroup($this->testUserGroup));
         self::assertTrue($this->testUser3->hasGroup($this->testUserGroup));
     }
+
+    public function test_it_can_assign_user_using_array_as_parameter()
+    {
+        self::assertInstanceOf(Group::class, $this->testUserGroup->assignUser([
+            $this->testUser->id,
+            $this->testUser2->id,
+            $this->testUser3->id,
+        ]));
+
+        self::assertTrue($this->testUser->hasGroup($this->testUserGroup));
+        self::assertTrue($this->testUser2->hasGroup($this->testUserGroup));
+        self::assertTrue($this->testUser3->hasGroup($this->testUserGroup));
+    }
 }