HasPermissions::getAllPermissions() - Code Metrics - Inspection of "Move permissions methods out of HasRoles trait" - spatie/laravel-permission - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#644)

by Chris

created 2018-03-03 23:15 UTC

HasPermissions::getAllPermissions() A

↳ Parent: HasPermissions

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	5
nc	1
nop	0
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0

<?php

namespace Spatie\Permission\Traits;

use Spatie\Permission\Guard;
use Illuminate\Support\Collection;
use Illuminate\Database\Eloquent\Builder;
use Spatie\Permission\PermissionRegistrar;
use Spatie\Permission\Contracts\Permission;
use Spatie\Permission\Exceptions\GuardDoesNotMatch;
use Illuminate\Database\Eloquent\Relations\MorphToMany;

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

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

    /**
     * A model may have multiple direct permissions.
     */
    public function permissions(): MorphToMany
    {
        return $this->morphToMany(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            config('permission.models.permission'),
            'model',
            config('permission.table_names.model_has_permissions'),
            'model_id',
            'permission_id'
        );
    }

    /**
     * Scope the model query to certain permissions only.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param string|array|\Spatie\Permission\Contracts\Permission|\Illuminate\Support\Collection $permissions
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopePermission(Builder $query, $permissions): Builder
    {
        $permissions = $this->convertToPermissionModels($permissions);

        $rolesWithPermissions = array_unique(array_reduce($permissions, function ($result, $permission) {
            return array_merge($result, $permission->roles->all());
        }, []));

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

    /**
     * @param string|array|\Spatie\Permission\Contracts\Permission|\Illuminate\Support\Collection $permissions
     *
     * @return array
     */
    protected function convertToPermissionModels($permissions): array
    {
        if ($permissions instanceof Collection) {
            $permissions = $permissions->toArray();
        }

        $permissions = array_wrap($permissions);

        return array_map(function ($permission) {
            if ($permission instanceof Permission) {
                return $permission;
            }

            return app(Permission::class)->findByName($permission, $this->getDefaultGuardName());
        }, $permissions);
    }

    /**
     * Determine if the model may perform the given permission.
     *
     * @param string|\Spatie\Permission\Contracts\Permission $permission
     * @param string|null $guardName
     *
     * @return bool
     */
    public function hasPermissionTo($permission, $guardName = null): bool
    {
        if (is_string($permission)) {

            $permission = app(Permission::class)->findByName(
                $permission,
                $guardName ?? $this->getDefaultGuardName()
            );
        }

        return $this->hasDirectPermission($permission) || $this->hasPermissionViaRole($permission);
    }

    /**
     * Determine if the model has any of the given permissions.
     *
     * @param array ...$permissions
     *
     * @return bool
     */
    public function hasAnyPermission(...$permissions): bool
    {
        if (is_array($permissions[0])) {
            $permissions = $permissions[0];
        }

        foreach ($permissions as $permission) {
            if ($this->hasPermissionTo($permission)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Determine if the model has, via roles, the given permission.
     *
     * @param \Spatie\Permission\Contracts\Permission $permission
     *
     * @return bool
     */
    protected function hasPermissionViaRole(Permission $permission): bool
    {
        return $this->hasRole($permission->roles);
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

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

    /**
     * Determine if the model has the given permission.
     *
     * @param string|\Spatie\Permission\Contracts\Permission $permission
     *
     * @return bool
     */
    public function hasDirectPermission($permission): bool
    {
        if (is_string($permission)) {

            $permission = app(Permission::class)->findByName($permission, $this->getDefaultGuardName());

            if (! $permission) {
                return false;
            }
        }

        return $this->permissions->contains('id', $permission->id);
class MyClass { }

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

    /**
     * Return all the permissions the model has via roles.
     */
    public function getPermissionsViaRoles(): Collection
    {
        return $this->load('roles', 'roles.permissions')
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            ->roles->flatMap(function ($role) {
                return $role->permissions;
            })->sort()->values();
    }

    /**
     * Return all the permissions the model has, both directly and via roles.
     */
    public function getAllPermissions(): Collection
    {
        return $this->permissions
            ->merge($this->getPermissionsViaRoles())
            ->sort()
            ->values();
    }

    /**
     * Grant the given permission(s) to a role.
     *
     * @param string|array|\Spatie\Permission\Contracts\Permission|\Illuminate\Support\Collection $permissions
     *
     * @return $this
     */
    public function givePermissionTo(...$permissions)

    {
        $permissions = collect($permissions)
            ->flatten()
            ->map(function ($permission) {
                return $this->getStoredPermission($permission);
            })
            ->each(function ($permission) {
                $this->ensureModelSharesGuard($permission);
            })
            ->all();

        $this->permissions()->saveMany($permissions);

        $this->forgetCachedPermissions();

        return $this;
    }

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

        return $this->givePermissionTo($permissions);
    }

    /**
     * Revoke the given permission.
     *
     * @param \Spatie\Permission\Contracts\Permission|\Spatie\Permission\Contracts\Permission[]|string|string[] $permission
     *
     * @return $this
     */
    public function revokePermissionTo($permission)
    {
        $this->permissions()->detach($this->getStoredPermission($permission));

        $this->forgetCachedPermissions();

        return $this;
    }

    /**
     * @param string|array|\Spatie\Permission\Contracts\Permission|\Illuminate\Support\Collection $permissions
     *
     * @return \Spatie\Permission\Contracts\Permission|\Spatie\Permission\Contracts\Permission[]|\Illuminate\Support\Collection
     */
    protected function getStoredPermission($permissions)
    {
        if (is_numeric($permissions)) {
            return app(Permission::class)->findById($permissions, $this->getDefaultGuardName());
        }

        if (is_string($permissions)) {
            return app(Permission::class)->findByName($permissions, $this->getDefaultGuardName());
        }

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

        return $permissions;
    }

    /**
     * @param \Spatie\Permission\Contracts\Permission|\Spatie\Permission\Contracts\Role $roleOrPermission
     *
     * @throws \Spatie\Permission\Exceptions\GuardDoesNotMatch
     */
    protected function ensureModelSharesGuard($roleOrPermission)
    {
        if (! $this->getGuardNames()->contains($roleOrPermission->guard_name)) {
            throw GuardDoesNotMatch::create($roleOrPermission->guard_name, $this->getGuardNames());
        }
    }

    protected function getGuardNames(): Collection
    {
        return Guard::getNames($this);
    }

    protected function getDefaultGuardName(): string
    {
        return Guard::getDefaultName($this);
    }

    /**
     * Forget the cached permissions.
     */
    public function forgetCachedPermissions()
    {
        app(PermissionRegistrar::class)->forgetCachedPermissions();
    }
}


1		<?php
2
3		namespace Spatie\Permission\Traits;
4
5		use Spatie\Permission\Guard;
6		use Illuminate\Support\Collection;
7		use Illuminate\Database\Eloquent\Builder;
8		use Spatie\Permission\PermissionRegistrar;
9		use Spatie\Permission\Contracts\Permission;
10		use Spatie\Permission\Exceptions\GuardDoesNotMatch;
11		use Illuminate\Database\Eloquent\Relations\MorphToMany;
12
13		trait HasPermissions
14		{
15		public static function bootHasPermissions()
16		{
17		static::deleting(function ($model) {
18		if (method_exists($model, 'isForceDeleting') && ! $model->isForceDeleting()) {
19		return;
20		}
21
22		$model->permissions()->detach();
23		});
24		}
25
26		/**
27		* A model may have multiple direct permissions.
28		*/
29		public function permissions(): MorphToMany
30		{
31		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...
32		config('permission.models.permission'),
33		'model',
34		config('permission.table_names.model_has_permissions'),
35		'model_id',
36		'permission_id'
37		);
38		}
39
40		/**
41		* Scope the model query to certain permissions only.
42		*
43		* @param \Illuminate\Database\Eloquent\Builder $query
44		* @param string\|array\|\Spatie\Permission\Contracts\Permission\|\Illuminate\Support\Collection $permissions
45		*
46		* @return \Illuminate\Database\Eloquent\Builder
47		*/
48		public function scopePermission(Builder $query, $permissions): Builder
49		{
50		$permissions = $this->convertToPermissionModels($permissions);
51
52		$rolesWithPermissions = array_unique(array_reduce($permissions, function ($result, $permission) {
53		return array_merge($result, $permission->roles->all());
54		}, []));
55
56		return $query->
57		where(function ($query) use ($permissions, $rolesWithPermissions) {
58		$query->whereHas('permissions', function ($query) use ($permissions) {
59		$query->where(function ($query) use ($permissions) {
60		foreach ($permissions as $permission) {
61		$query->orWhere(config('permission.table_names.permissions').'.id', $permission->id);
62		}
63		});
64		});
65		if (count($rolesWithPermissions) > 0) {
66		$query->orWhereHas('roles', function ($query) use ($rolesWithPermissions) {
67		$query->where(function ($query) use ($rolesWithPermissions) {
68		foreach ($rolesWithPermissions as $role) {
69		$query->orWhere(config('permission.table_names.roles').'.id', $role->id);
70		}
71		});
72		});
73		}
74		});
75		}
76
77		/**
78		* @param string\|array\|\Spatie\Permission\Contracts\Permission\|\Illuminate\Support\Collection $permissions
79		*
80		* @return array
81		*/
82		protected function convertToPermissionModels($permissions): array
83		{
84		if ($permissions instanceof Collection) {
85		$permissions = $permissions->toArray();
86		}
87
88		$permissions = array_wrap($permissions);
89
90		return array_map(function ($permission) {
91		if ($permission instanceof Permission) {
92		return $permission;
93		}
94
95		return app(Permission::class)->findByName($permission, $this->getDefaultGuardName());
96		}, $permissions);
97		}
98
99		/**
100		* Determine if the model may perform the given permission.
101		*
102		* @param string\|\Spatie\Permission\Contracts\Permission $permission
103		* @param string\|null $guardName
104		*
105		* @return bool
106		*/
107		public function hasPermissionTo($permission, $guardName = null): bool
108		{
109	View Code Duplication	if (is_string($permission)) {
		0 ignored issues – show Duplication introduced 2017-06-06 16:24 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...
110		$permission = app(Permission::class)->findByName(
111		$permission,
112		$guardName ?? $this->getDefaultGuardName()
113		);
114		}
115
116		return $this->hasDirectPermission($permission) \|\| $this->hasPermissionViaRole($permission);
117		}
118
119		/**
120		* Determine if the model has any of the given permissions.
121		*
122		* @param array ...$permissions
123		*
124		* @return bool
125		*/
126		public function hasAnyPermission(...$permissions): bool
127		{
128		if (is_array($permissions[0])) {
129		$permissions = $permissions[0];
130		}
131
132		foreach ($permissions as $permission) {
133		if ($this->hasPermissionTo($permission)) {
134		return true;
135		}
136		}
137
138		return false;
139		}
140
141		/**
142		* Determine if the model has, via roles, the given permission.
143		*
144		* @param \Spatie\Permission\Contracts\Permission $permission
145		*
146		* @return bool
147		*/
148		protected function hasPermissionViaRole(Permission $permission): bool
149		{
150		return $this->hasRole($permission->roles);
		0 ignored issues – show Bug introduced 2015-12-21 23:32 UTC by Report Bug Copy Issue Report Accessing `roles` on the interface `Spatie\Permission\Contracts\Permission` 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... Bug introduced 2018-02-05 03:35 UTC by Report Bug Copy Issue Report It seems like `hasRole()` 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...
151		}
152
153		/**
154		* Determine if the model has the given permission.
155		*
156		* @param string\|\Spatie\Permission\Contracts\Permission $permission
157		*
158		* @return bool
159		*/
160		public function hasDirectPermission($permission): bool
161		{
162	View Code Duplication	if (is_string($permission)) {
		0 ignored issues – show Duplication introduced 2017-06-06 16:24 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...
163		$permission = app(Permission::class)->findByName($permission, $this->getDefaultGuardName());
164
165		if (! $permission) {
166		return false;
167		}
168		}
169
170		return $this->permissions->contains('id', $permission->id);
		0 ignored issues – show Bug introduced 2015-12-21 23:32 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...
171		}
172
173		/**
174		* Return all the permissions the model has via roles.
175		*/
176		public function getPermissionsViaRoles(): Collection
177		{
178		return $this->load('roles', 'roles.permissions')
		0 ignored issues – show Bug introduced 2017-02-22 12:47 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...
179		->roles->flatMap(function ($role) {
180		return $role->permissions;
181		})->sort()->values();
182		}
183
184		/**
185		* Return all the permissions the model has, both directly and via roles.
186		*/
187		public function getAllPermissions(): Collection
188		{
189		return $this->permissions
190		->merge($this->getPermissionsViaRoles())
191		->sort()
192		->values();
193		}
194
195		/**
196		* Grant the given permission(s) to a role.
197		*
198		* @param string\|array\|\Spatie\Permission\Contracts\Permission\|\Illuminate\Support\Collection $permissions
199		*
200		* @return $this
201		*/
202	View Code Duplication	public function givePermissionTo(...$permissions)
		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...
203		{
204		$permissions = collect($permissions)
205		->flatten()
206		->map(function ($permission) {
207		return $this->getStoredPermission($permission);
208		})
209		->each(function ($permission) {
210		$this->ensureModelSharesGuard($permission);
211		})
212		->all();
213
214		$this->permissions()->saveMany($permissions);
215
216		$this->forgetCachedPermissions();
217
218		return $this;
219		}
220
221		/**
222		* Remove all current permissions and set the given ones.
223		*
224		* @param string\|array\|\Spatie\Permission\Contracts\Permission\|\Illuminate\Support\Collection $permissions
225		*
226		* @return $this
227		*/
228		public function syncPermissions(...$permissions)
229		{
230		$this->permissions()->detach();
231
232		return $this->givePermissionTo($permissions);
233		}
234
235		/**
236		* Revoke the given permission.
237		*
238		* @param \Spatie\Permission\Contracts\Permission\|\Spatie\Permission\Contracts\Permission[]\|string\|string[] $permission
239		*
240		* @return $this
241		*/
242		public function revokePermissionTo($permission)
243		{
244		$this->permissions()->detach($this->getStoredPermission($permission));
245
246		$this->forgetCachedPermissions();
247
248		return $this;
249		}
250
251		/**
252		* @param string\|array\|\Spatie\Permission\Contracts\Permission\|\Illuminate\Support\Collection $permissions
253		*
254		* @return \Spatie\Permission\Contracts\Permission\|\Spatie\Permission\Contracts\Permission[]\|\Illuminate\Support\Collection
255		*/
256		protected function getStoredPermission($permissions)
257		{
258		if (is_numeric($permissions)) {
259		return app(Permission::class)->findById($permissions, $this->getDefaultGuardName());
260		}
261
262		if (is_string($permissions)) {
263		return app(Permission::class)->findByName($permissions, $this->getDefaultGuardName());
264		}
265
266		if (is_array($permissions)) {
267		return app(Permission::class)
268		->whereIn('name', $permissions)
269		->whereIn('guard_name', $this->getGuardNames())
270		->get();
271		}
272
273		return $permissions;
274		}
275
276		/**
277		* @param \Spatie\Permission\Contracts\Permission\|\Spatie\Permission\Contracts\Role $roleOrPermission
278		*
279		* @throws \Spatie\Permission\Exceptions\GuardDoesNotMatch
280		*/
281		protected function ensureModelSharesGuard($roleOrPermission)
282		{
283		if (! $this->getGuardNames()->contains($roleOrPermission->guard_name)) {
284		throw GuardDoesNotMatch::create($roleOrPermission->guard_name, $this->getGuardNames());
285		}
286		}
287
288		protected function getGuardNames(): Collection
289		{
290		return Guard::getNames($this);
291		}
292
293		protected function getDefaultGuardName(): string
294		{
295		return Guard::getDefaultName($this);
296		}
297
298		/**
299		* Forget the cached permissions.
300		*/
301		public function forgetCachedPermissions()
302		{
303		app(PermissionRegistrar::class)->forgetCachedPermissions();
304		}
305		}
306

spatie / laravel-permission

Pull Request — master (#644)

HasPermissions::getAllPermissions() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like