HasRoles - Code Metrics - Inspection of "Add scopeWhereRole to hasRoles trait" - spatie/laravel-permission - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1336)

unknown

created 2020-01-18 23:35 UTC

HasRoles C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	343
Duplicated Lines	18.08 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

Metric	Value
dl	62
loc	343
rs	5.04
c	0
b	0
f	0
wmc	57
lcom	1
cbo	4

15 Methods

Rating	Name	Duplication	Size	Complexity
A	getRoleClass()	0	8	2
A	roles()	0	10	1
A	bootHasRoles()	0	10	3
B	scopeRole()	0	29	7
B	scopeWhereRole()	0	32	7
B	assignRole()	44	44	5
A	removeRole()	0	10	1
A	syncRoles()	0	6	1
C	hasRole()	11	34	12
A	hasAnyRole()	0	4	1
B	hasAllRoles()	7	25	8
A	getDirectPermissions()	0	4	1
A	getRoleNames()	0	4	1
A	getStoredRole()	0	14	3
A	convertPipeToArray()	0	21	4

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like HasRoles often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use HasRoles, and based on these observations, apply Extract Interface, too.

<?php

namespace Spatie\Permission\Traits;

use Illuminate\Support\Collection;
use Spatie\Permission\Contracts\Role;
use Illuminate\Database\Eloquent\Builder;
use Spatie\Permission\PermissionRegistrar;
use Illuminate\Database\Eloquent\Relations\MorphToMany;

trait HasRoles
{
    use HasPermissions;

    private $roleClass;

    public static function bootHasRoles()
    {
        static::deleting(function ($model) {
            if (method_exists($model, 'isForceDeleting') && ! $model->isForceDeleting()) {
                return;
            }

            $model->roles()->detach();
        });
    }

    public function getRoleClass()
    {
        if (! isset($this->roleClass)) {
            $this->roleClass = app(PermissionRegistrar::class)->getRoleClass();
        }

        return $this->roleClass;
    }

    /**
     * A model may have multiple roles.
     */
    public function roles(): MorphToMany
    {
        return $this->morphToMany(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            config('permission.models.role'),
            'model',
            config('permission.table_names.model_has_roles'),
            config('permission.column_names.model_morph_key'),
            'role_id'
        );
    }

    /**
     * Scope the model query to certain roles only.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param string|array|\Spatie\Permission\Contracts\Role|\Illuminate\Support\Collection $roles
     * @param string $guard
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeRole(Builder $query, $roles, $guard = null): Builder
    {
        if ($roles instanceof Collection) {
            $roles = $roles->all();
        }

        if (! is_array($roles)) {
            $roles = [$roles];
        }

        $roles = array_map(function ($role) use ($guard) {
            if ($role instanceof Role) {
                return $role;
            }

            $method = is_numeric($role) ? 'findById' : 'findByName';
            $guard = $guard ?: $this->getDefaultGuardName();
$x = 1;
$callable = function() use ($x) {
    $x = 2; // Not visible in outer scope. If you would like this, how
            // about using a different variable name than $x?
};

$callable();
var_dump($x); // integer(1)

            return $this->getRoleClass()->{$method}($role, $guard);
        }, $roles);

        return $query->whereHas('roles', function ($query) use ($roles) {
            $query->where(function ($query) use ($roles) {
                foreach ($roles as $role) {
                    $query->orWhere(config('permission.table_names.roles').'.id', $role->id);
                }
            });
        });
    }

    /**
     * Scope the model query to certain roles only.
     * This will not return an exception if the role does not exist.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param string|array|\Spatie\Permission\Contracts\Role|\Illuminate\Support\Collection $roles
     * @param string $guard
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeWhereRole(Builder $query, $roles, $guard = null): Builder
    {
        if ($roles instanceof Collection) {
            $roles = $roles->all();
        }

        if (! is_array($roles)) {
            $roles = [$roles];
        }

        $roles = collect($roles)->map(function ($role) {
            if ($role instanceof Role) {
                return $role->id;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            }

            return $role;
        })->unique();

        $guard = is_null($guard) ? $this->getDefaultGuardName() : $guard;

        return $query->whereHas('roles', function ($query) use ($roles, $guard) {
            $query->where(function ($query) use ($roles, $guard) {
                foreach ($roles as $role) {
                    $column = is_numeric($role) ? 'id' : 'name';
                    $query->orWhere([
                        [config('permission.table_names.roles').".{$column}", '=', $role],
                        [config('permission.table_names.roles').'.guard_name', '=', $guard],
                    ]);
                }
            });
        });
    }
    
    /**
     * Assign the given role to the model.
     *
     * @param array|string|\Spatie\Permission\Contracts\Role ...$roles
     *
     * @return $this
     */
    public function assignRole(...$roles)

    {
        $roles = collect($roles)
            ->flatten()
            ->map(function ($role) {
                if (empty($role)) {
                    return false;
                }

                return $this->getStoredRole($role);
            })
            ->filter(function ($role) {
                return $role instanceof Role;
            })
            ->each(function ($role) {
                $this->ensureModelSharesGuard($role);
            })
            ->map->id
            ->all();

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

        if ($model->exists) {
            $this->roles()->sync($roles, false);
            $model->load('roles');
        } else {
            $class = \get_class($model);

            $class::saved(
                function ($object) use ($roles, $model) {
                    static $modelLastFiredOn;
                    if ($modelLastFiredOn !== null && $modelLastFiredOn === $model) {
                        return;
                    }
                    $object->roles()->sync($roles, false);
                    $object->load('roles');
                    $modelLastFiredOn = $object;
                });
        }

        $this->forgetCachedPermissions();

        return $this;
    }

    /**
     * Revoke the given role from the model.
     *
     * @param string|\Spatie\Permission\Contracts\Role $role
     */
    public function removeRole($role)
    {
        $this->roles()->detach($this->getStoredRole($role));

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

        $this->forgetCachedPermissions();

        return $this;
    }

    /**
     * Remove all current roles and set the given ones.
     *
     * @param  array|\Spatie\Permission\Contracts\Role|string  ...$roles
     *
     * @return $this
     */
    public function syncRoles(...$roles)
    {
        $this->roles()->detach();

        return $this->assignRole($roles);
    }

    /**
     * Determine if the model has (one of) the given role(s).
     *
     * @param string|int|array|\Spatie\Permission\Contracts\Role|\Illuminate\Support\Collection $roles
     * @param string|null $guard
     * @return bool
     */
    public function hasRole($roles, string $guard = null): bool
    {
        if (is_string($roles) && false !== strpos($roles, '|')) {

            $roles = $this->convertPipeToArray($roles);
        }

        if (is_string($roles)) {

            return $guard
                ? $this->roles->where('guard_name', $guard)->contains('name', $roles)
class MyClass { }

$x = new MyClass();
$x->foo = true;
                : $this->roles->contains('name', $roles);
        }

        if (is_int($roles)) {

            return $guard
                ? $this->roles->where('guard_name', $guard)->contains('id', $roles)
                : $this->roles->contains('id', $roles);
        }

        if ($roles instanceof Role) {
            return $this->roles->contains('id', $roles->id);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        }

        if (is_array($roles)) {
            foreach ($roles as $role) {
                if ($this->hasRole($role, $guard)) {
                    return true;
                }
            }

            return false;
        }

        return $roles->intersect($guard ? $this->roles->where('guard_name', $guard) : $this->roles)->isNotEmpty();
    }

    /**
     * Determine if the model has any of the given role(s).
     *
     * Alias to hasRole() but without Guard controls
     *
     * @param string|int|array|\Spatie\Permission\Contracts\Role|\Illuminate\Support\Collection $roles
     *
     * @return bool
     */
    public function hasAnyRole(...$roles): bool
    {
        return $this->hasRole($roles);
    }

    /**
     * Determine if the model has all of the given role(s).
     *
     * @param  string|array|\Spatie\Permission\Contracts\Role|\Illuminate\Support\Collection  $roles
     * @param  string|null  $guard
     * @return bool
     */
    public function hasAllRoles($roles, string $guard = null): bool
    {
        if (is_string($roles) && false !== strpos($roles, '|')) {

            $roles = $this->convertPipeToArray($roles);
        }

        if (is_string($roles)) {

            return $guard
                ? $this->roles->where('guard_name', $guard)->contains('name', $roles)
                : $this->roles->contains('name', $roles);
        }

        if ($roles instanceof Role) {
            return $this->roles->contains('id', $roles->id);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        }

        $roles = collect()->make($roles)->map(function ($role) {
            return $role instanceof Role ? $role->name : $role;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        });

        return $roles->intersect(
            $guard
                ? $this->roles->where('guard_name', $guard)->pluck('name')
                : $this->getRoleNames()) == $roles;
    }

    /**
     * Return all permissions directly coupled to the model.
     */
    public function getDirectPermissions(): Collection
    {
        return $this->permissions;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    public function getRoleNames(): Collection
    {
        return $this->roles->pluck('name');
    }

    protected function getStoredRole($role): Role
    {
        $roleClass = $this->getRoleClass();

        if (is_numeric($role)) {
            return $roleClass->findById($role, $this->getDefaultGuardName());
        }

        if (is_string($role)) {
            return $roleClass->findByName($role, $this->getDefaultGuardName());
        }

        return $role;
    }

    protected function convertPipeToArray(string $pipeString)
    {
        $pipeString = trim($pipeString);

        if (strlen($pipeString) <= 2) {
            return $pipeString;
        }

        $quoteCharacter = substr($pipeString, 0, 1);
        $endCharacter = substr($quoteCharacter, -1, 1);

        if ($quoteCharacter !== $endCharacter) {
            return explode('|', $pipeString);
        }

        if (! in_array($quoteCharacter, ["'", '"'])) {
            return explode('|', $pipeString);
        }

        return explode('|', trim($pipeString, $quoteCharacter));
    }
}


Pull Request — master (#1336)

HasRoles C

Complexity

Size/Duplication

Coupling/Cohesion

Importance

15 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Change not visible in outer-scope

Change visible in outer-scope

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1		<?php
2
3		namespace Spatie\Permission\Traits;
4
5		use Illuminate\Support\Collection;
6		use Spatie\Permission\Contracts\Role;
7		use Illuminate\Database\Eloquent\Builder;
8		use Spatie\Permission\PermissionRegistrar;
9		use Illuminate\Database\Eloquent\Relations\MorphToMany;
10
11		trait HasRoles
12		{
13		use HasPermissions;
14
15		private $roleClass;
16
17		public static function bootHasRoles()
18		{
19		static::deleting(function ($model) {
20		if (method_exists($model, 'isForceDeleting') && ! $model->isForceDeleting()) {
21		return;
22		}
23
24		$model->roles()->detach();
25		});
26		}
27
28		public function getRoleClass()
29		{
30		if (! isset($this->roleClass)) {
31		$this->roleClass = app(PermissionRegistrar::class)->getRoleClass();
32		}
33
34		return $this->roleClass;
35		}
36
37		/**
38		* A model may have multiple roles.
39		*/
40		public function roles(): MorphToMany
41		{
42		return $this->morphToMany(
		0 ignored issues – show Bug introduced 2017-04-20 14:18 UTC by Report Bug Copy Issue Report It seems like `morphToMany()` 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...
43		config('permission.models.role'),
44		'model',
45		config('permission.table_names.model_has_roles'),
46		config('permission.column_names.model_morph_key'),
47		'role_id'
48		);
49		}
50
51		/**
52		* Scope the model query to certain roles only.
53		*
54		* @param \Illuminate\Database\Eloquent\Builder $query
55		* @param string\|array\|\Spatie\Permission\Contracts\Role\|\Illuminate\Support\Collection $roles
56		* @param string $guard
57		*
58		* @return \Illuminate\Database\Eloquent\Builder
59		*/
60		public function scopeRole(Builder $query, $roles, $guard = null): Builder
61		{
62		if ($roles instanceof Collection) {
63		$roles = $roles->all();
64		}
65
66		if (! is_array($roles)) {
67		$roles = [$roles];
68		}
69
70		$roles = array_map(function ($role) use ($guard) {
71		if ($role instanceof Role) {
72		return $role;
73		}
74
75		$method = is_numeric($role) ? 'findById' : 'findByName';
76		$guard = $guard ?: $this->getDefaultGuardName();
		0 ignored issues – show Bug introduced 2019-02-03 07:15 UTC by Report Bug Copy Issue Report Consider using a different name than the imported variable `$guard`, or did you forget to import by reference? It seems like you are assigning to a variable which was imported through a `use` statement which was not imported by reference. For clarity, we suggest to use a different name or import by reference depending on whether you would like to have the change visibile in outer-scope. Change not visible in outer-scope $x = 1; $callable = function() use ($x) { $x = 2; // Not visible in outer scope. If you would like this, how // about using a different variable name than $x? }; $callable(); var_dump($x); // integer(1) Change visible in outer-scope $x = 1; $callable = function() use (&$x) { $x = 2; }; $callable(); var_dump($x); // integer(2) Loading history...
77
78		return $this->getRoleClass()->{$method}($role, $guard);
79		}, $roles);
80
81		return $query->whereHas('roles', function ($query) use ($roles) {
82		$query->where(function ($query) use ($roles) {
83		foreach ($roles as $role) {
84		$query->orWhere(config('permission.table_names.roles').'.id', $role->id);
85		}
86		});
87		});
88		}
89
90		/**
91		* Scope the model query to certain roles only.
92		* This will not return an exception if the role does not exist.
93		*
94		* @param \Illuminate\Database\Eloquent\Builder $query
95		* @param string\|array\|\Spatie\Permission\Contracts\Role\|\Illuminate\Support\Collection $roles
96		* @param string $guard
97		*
98		* @return \Illuminate\Database\Eloquent\Builder
99		*/
100		public function scopeWhereRole(Builder $query, $roles, $guard = null): Builder
101		{
102		if ($roles instanceof Collection) {
103		$roles = $roles->all();
104		}
105
106		if (! is_array($roles)) {
107		$roles = [$roles];
108		}
109
110		$roles = collect($roles)->map(function ($role) {
111		if ($role instanceof Role) {
112		return $role->id;
		0 ignored issues – show Bug introduced 2020-01-18 23:36 UTC by Report Bug Copy Issue Report Accessing `id` on the interface `Spatie\Permission\Contracts\Role` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
113		}
114
115		return $role;
116		})->unique();
117
118		$guard = is_null($guard) ? $this->getDefaultGuardName() : $guard;
119
120		return $query->whereHas('roles', function ($query) use ($roles, $guard) {
121		$query->where(function ($query) use ($roles, $guard) {
122		foreach ($roles as $role) {
123		$column = is_numeric($role) ? 'id' : 'name';
124		$query->orWhere([
125		[config('permission.table_names.roles').".{$column}", '=', $role],
126		[config('permission.table_names.roles').'.guard_name', '=', $guard],
127		]);
128		}
129		});
130		});
131		}
132
133		/**
134		* Assign the given role to the model.
135		*
136		* @param array\|string\|\Spatie\Permission\Contracts\Role ...$roles
137		*
138		* @return $this
139		*/
140	View Code Duplication	public function assignRole(...$roles)
		0 ignored issues – show Duplication introduced 2017-08-07 17:04 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
141		{
142		$roles = collect($roles)
143		->flatten()
144		->map(function ($role) {
145		if (empty($role)) {
146		return false;
147		}
148
149		return $this->getStoredRole($role);
150		})
151		->filter(function ($role) {
152		return $role instanceof Role;
153		})
154		->each(function ($role) {
155		$this->ensureModelSharesGuard($role);
156		})
157		->map->id
158		->all();
159
160		$model = $this->getModel();
		0 ignored issues – show Bug introduced 2018-09-20 00:40 UTC by Report Bug Copy Issue Report It seems like `getModel()` 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...
161
162		if ($model->exists) {
163		$this->roles()->sync($roles, false);
164		$model->load('roles');
165		} else {
166		$class = \get_class($model);
167
168		$class::saved(
169		function ($object) use ($roles, $model) {
170		static $modelLastFiredOn;
171		if ($modelLastFiredOn !== null && $modelLastFiredOn === $model) {
172		return;
173		}
174		$object->roles()->sync($roles, false);
175		$object->load('roles');
176		$modelLastFiredOn = $object;
177		});
178		}
179
180		$this->forgetCachedPermissions();
181
182		return $this;
183		}
184
185		/**
186		* Revoke the given role from the model.
187		*
188		* @param string\|\Spatie\Permission\Contracts\Role $role
189		*/
190		public function removeRole($role)
191		{
192		$this->roles()->detach($this->getStoredRole($role));
193
194		$this->load('roles');
		0 ignored issues – show Bug introduced 2019-12-20 21:50 UTC by Report Bug Copy Issue Report It seems like `load()` 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...
195
196		$this->forgetCachedPermissions();
197
198		return $this;
199		}
200
201		/**
202		* Remove all current roles and set the given ones.
203		*
204		* @param array\|\Spatie\Permission\Contracts\Role\|string ...$roles
205		*
206		* @return $this
207		*/
208		public function syncRoles(...$roles)
209		{
210		$this->roles()->detach();
211
212		return $this->assignRole($roles);
213		}
214
215		/**
216		* Determine if the model has (one of) the given role(s).
217		*
218		* @param string\|int\|array\|\Spatie\Permission\Contracts\Role\|\Illuminate\Support\Collection $roles
219		* @param string\|null $guard
220		* @return bool
221		*/
222		public function hasRole($roles, string $guard = null): bool
223		{
224	View Code Duplication	if (is_string($roles) && false !== strpos($roles, '\|')) {
		0 ignored issues – show Duplication introduced 2017-08-06 02:15 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
225		$roles = $this->convertPipeToArray($roles);
226		}
227
228	View Code Duplication	if (is_string($roles)) {
		0 ignored issues – show Duplication introduced 2019-10-07 16:39 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
229		return $guard
230		? $this->roles->where('guard_name', $guard)->contains('name', $roles)
		0 ignored issues – show Bug introduced 2019-10-07 16:39 UTC by Report Bug Copy Issue Report The property `roles` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
231		: $this->roles->contains('name', $roles);
232		}
233
234	View Code Duplication	if (is_int($roles)) {
		0 ignored issues – show Duplication introduced 2019-10-07 16:39 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
235		return $guard
236		? $this->roles->where('guard_name', $guard)->contains('id', $roles)
237		: $this->roles->contains('id', $roles);
238		}
239
240		if ($roles instanceof Role) {
241		return $this->roles->contains('id', $roles->id);
		0 ignored issues – show Bug introduced 2017-03-31 08:07 UTC by Report Bug Copy Issue Report Accessing `id` on the interface `Spatie\Permission\Contracts\Role` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
242		}
243
244		if (is_array($roles)) {
245		foreach ($roles as $role) {
246		if ($this->hasRole($role, $guard)) {
247		return true;
248		}
249		}
250
251		return false;
252		}
253
254		return $roles->intersect($guard ? $this->roles->where('guard_name', $guard) : $this->roles)->isNotEmpty();
255		}
256
257		/**
258		* Determine if the model has any of the given role(s).
259		*
260		* Alias to hasRole() but without Guard controls
261		*
262		* @param string\|int\|array\|\Spatie\Permission\Contracts\Role\|\Illuminate\Support\Collection $roles
263		*
264		* @return bool
265		*/
266		public function hasAnyRole(...$roles): bool
267		{
268		return $this->hasRole($roles);
269		}
270
271		/**
272		* Determine if the model has all of the given role(s).
273		*
274		* @param string\|array\|\Spatie\Permission\Contracts\Role\|\Illuminate\Support\Collection $roles
275		* @param string\|null $guard
276		* @return bool
277		*/
278		public function hasAllRoles($roles, string $guard = null): bool
279		{
280	View Code Duplication	if (is_string($roles) && false !== strpos($roles, '\|')) {
		0 ignored issues – show Duplication introduced 2017-08-06 02:15 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
281		$roles = $this->convertPipeToArray($roles);
282		}
283
284	View Code Duplication	if (is_string($roles)) {
		0 ignored issues – show Duplication introduced 2019-10-07 16:39 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
285		return $guard
286		? $this->roles->where('guard_name', $guard)->contains('name', $roles)
287		: $this->roles->contains('name', $roles);
288		}
289
290		if ($roles instanceof Role) {
291		return $this->roles->contains('id', $roles->id);
		0 ignored issues – show Bug introduced 2017-03-23 16:51 UTC by Report Bug Copy Issue Report Accessing `id` on the interface `Spatie\Permission\Contracts\Role` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
292		}
293
294		$roles = collect()->make($roles)->map(function ($role) {
295		return $role instanceof Role ? $role->name : $role;
		0 ignored issues – show Bug introduced 2015-12-21 23:32 UTC by Report Bug Copy Issue Report Accessing `name` on the interface `Spatie\Permission\Contracts\Role` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
296		});
297
298		return $roles->intersect(
299		$guard
300		? $this->roles->where('guard_name', $guard)->pluck('name')
301		: $this->getRoleNames()) == $roles;
302		}
303
304		/**
305		* Return all permissions directly coupled to the model.
306		*/
307		public function getDirectPermissions(): Collection
308		{
309		return $this->permissions;
		0 ignored issues – show Bug introduced 2018-02-05 03:35 UTC by Report Bug Copy Issue Report The property `permissions` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
310		}
311
312		public function getRoleNames(): Collection
313		{
314		return $this->roles->pluck('name');
315		}
316
317		protected function getStoredRole($role): Role
318		{
319		$roleClass = $this->getRoleClass();
320
321		if (is_numeric($role)) {
322		return $roleClass->findById($role, $this->getDefaultGuardName());
323		}
324
325		if (is_string($role)) {
326		return $roleClass->findByName($role, $this->getDefaultGuardName());
327		}
328
329		return $role;
330		}
331
332		protected function convertPipeToArray(string $pipeString)
333		{
334		$pipeString = trim($pipeString);
335
336		if (strlen($pipeString) <= 2) {
337		return $pipeString;
338		}
339
340		$quoteCharacter = substr($pipeString, 0, 1);
341		$endCharacter = substr($quoteCharacter, -1, 1);
342
343		if ($quoteCharacter !== $endCharacter) {
344		return explode('\|', $pipeString);
345		}
346
347		if (! in_array($quoteCharacter, ["'", '"'])) {
348		return explode('\|', $pipeString);
349		}
350
351		return explode('\|', trim($pipeString, $quoteCharacter));
352		}
353		}
354

spatie / laravel-permission

Pull Request — master (#1336)

HasRoles C

Complexity

Size/Duplication

Coupling/Cohesion

Importance

15 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Change not visible in outer-scope

Change visible in outer-scope

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like