HasPermissions::usingMultipleArguments() - Code Metrics - Inspection of "Allow givePermissionTo to accept multiple permissi..." - spatie/laravel-permission - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 013627...ed6b20 )

by Freek

created 2016-07-23 21:07 UTC

HasPermissions::usingMultipleArguments() A

↳ Parent: HasPermissions

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	1

<?php

namespace Spatie\Permission\Traits;

use Spatie\Permission\Contracts\Permission;
use Spatie\Permission\Exceptions\PermissionMustNotBeEmpty;

trait HasPermissions
{
    /**
     * Grant the given permission(s) to a role.
     *
     * @param string|array|Permission|\Illuminate\Support\Collection $permissions
     *
     * @return HasPermissions

     */
    public function givePermissionTo(...$permissions)
    {
        if(count($permissions) < 1) {
            throw new PermissionMustNotBeEmpty();
        }

        if (!$this->usingMultipleArguments($permissions)) {
            $permissions = current($permissions);
        }

        $this->savePermissions($permissions);

        $this->forgetCachedPermissions();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        return $this;
    }
    
    /**
     * Save the given permissions to a role.
     *
     * @param array|Permission|\Illuminate\Support\Collection $permissions
     * 
     * @return array|\Illuminate\Database\Eloquent\Model
     */
    protected function savePermissions($permissions)
    {
        $permissions = $this->getStoredPermission($permissions);

        if($permissions instanceof \Illuminate\Database\Eloquent\Collection) {
            return $this->permissions()->saveMany($permissions);

        }

        return $this->permissions()->save($permissions);

    }

    /**
     * Revoke the given permission.
     *
     * @param $permission
     *
     * @return HasPermissions

     */
    public function revokePermissionTo($permission)
    {
        $this->permissions()->detach($this->getStoredPermission($permission));


        $this->forgetCachedPermissions();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        return $this;
    }

    /**
     * @param string|array|Permission|\Illuminate\Support\Collection $permissions
     *
     * @return Permission
     */
    protected function getStoredPermission($permissions)
    {
        if (is_string($permissions)) {
            return app(Permission::class)->findByName($permissions);
        }

        if (is_array($permissions)) {
            return app(Permission::class)->whereIn('name', $permissions)->get();
        }

        return $permissions;
    }

    /**
     * @param $params
     * @return bool
     */
    private function usingMultipleArguments($params)
    {
        return count($params) > 1;
    }

}


1			<?php
2
3			namespace Spatie\Permission\Traits;
4
5			use Spatie\Permission\Contracts\Permission;
6			use Spatie\Permission\Exceptions\PermissionMustNotBeEmpty;
7
8			trait HasPermissions
9			{
10			/**
11			* Grant the given permission(s) to a role.
12			*
13			* @param string\|array\|Permission\|\Illuminate\Support\Collection $permissions
14			*
15			* @return HasPermissions
			0 ignored issues – show Comprehensibility Bug introduced 2015-12-21 23:32 UTC by Report Bug Copy Issue Report The return type `HasPermissions` is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting? In PHP traits cannot be used for type-hinting as they do not define a well-defined structure. This is because any class that uses a trait can rename that trait’s methods. If you would like to return an object that has a guaranteed set of methods, you could create a companion interface that lists these methods explicitly. Loading history...
16			*/
17			public function givePermissionTo(...$permissions)
18			{
19			if(count($permissions) < 1) {
20			throw new PermissionMustNotBeEmpty();
21			}
22
23			if (!$this->usingMultipleArguments($permissions)) {
24			$permissions = current($permissions);
25			}
26
27			$this->savePermissions($permissions);
28
29			$this->forgetCachedPermissions();
			0 ignored issues – show Bug introduced 2015-12-21 23:32 UTC by Report Bug Copy Issue Report It seems like `forgetCachedPermissions()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
30
31			return $this;
32			}
33
34			/**
35			* Save the given permissions to a role.
36			*
37			* @param array\|Permission\|\Illuminate\Support\Collection $permissions
38			*
39			* @return array\|\Illuminate\Database\Eloquent\Model
40			*/
41			protected function savePermissions($permissions)
42			{
43			$permissions = $this->getStoredPermission($permissions);
44
45			if($permissions instanceof \Illuminate\Database\Eloquent\Collection) {
46			return $this->permissions()->saveMany($permissions);
			0 ignored issues – show Bug introduced 2016-07-21 13:39 UTC by Report Bug Copy Issue Report The method `permissions()` does not exist on `Spatie\Permission\Traits\HasPermissions`. Did you maybe mean `savePermissions()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
47			}
48
49			return $this->permissions()->save($permissions);
			0 ignored issues – show Bug introduced 2016-07-20 15:49 UTC by Report Bug Copy Issue Report The method `permissions()` does not exist on `Spatie\Permission\Traits\HasPermissions`. Did you maybe mean `savePermissions()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
50			}
51
52			/**
53			* Revoke the given permission.
54			*
55			* @param $permission
56			*
57			* @return HasPermissions
			0 ignored issues – show Comprehensibility Bug introduced 2015-12-21 23:32 UTC by Report Bug Copy Issue Report The return type `HasPermissions` is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting? In PHP traits cannot be used for type-hinting as they do not define a well-defined structure. This is because any class that uses a trait can rename that trait’s methods. If you would like to return an object that has a guaranteed set of methods, you could create a companion interface that lists these methods explicitly. Loading history...
58			*/
59			public function revokePermissionTo($permission)
60			{
61			$this->permissions()->detach($this->getStoredPermission($permission));
			0 ignored issues – show Bug introduced 2016-07-20 15:49 UTC by Report Bug Copy Issue Report The method `permissions()` does not exist on `Spatie\Permission\Traits\HasPermissions`. Did you maybe mean `savePermissions()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
62
63			$this->forgetCachedPermissions();
			0 ignored issues – show Bug introduced 2015-12-21 23:32 UTC by Report Bug Copy Issue Report It seems like `forgetCachedPermissions()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
64
65			return $this;
66			}
67
68			/**
69			* @param string\|array\|Permission\|\Illuminate\Support\Collection $permissions
70			*
71			* @return Permission
72			*/
73			protected function getStoredPermission($permissions)
74			{
75			if (is_string($permissions)) {
76			return app(Permission::class)->findByName($permissions);
77			}
78
79			if (is_array($permissions)) {
80			return app(Permission::class)->whereIn('name', $permissions)->get();
81			}
82
83			return $permissions;
84			}
85
86			/**
87			* @param $params
88			* @return bool
89			*/
90			private function usingMultipleArguments($params)
91			{
92			return count($params) > 1;
93			}
94
95			}
96

spatie / laravel-permission

Push — master ( 013627...ed6b20 )

HasPermissions::usingMultipleArguments() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like