HasRoleAndPermission::grantPermissionBySlug() - Code Metrics - Inspection of "[6.x] WIP: Allow users to directly have permission..." - yajra/laravel-acl - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#38)

by Arjay

created 2021-04-17 09:11 UTC

HasRoleAndPermission::grantPermissionBySlug() A

↳ Parent: HasRoleAndPermission

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	11
rs	9.9
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

namespace Yajra\Acl\Traits;

use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Yajra\Acl\Models\Permission;

/**
 * @mixin \Illuminate\Database\Eloquent\Model
 * @property Permission[]|\Illuminate\Database\Eloquent\Collection $permissions
 */
trait HasRoleAndPermission
{
    use HasRole {
        HasRole::getPermissions as getRolePermissions;
    }

    private $permissionClass;

    /**
     * Grant user permission by slug.
     *
     * @param  string|array  $slug
     */
    public function grantPermissionBySlug($slug)
    {
        $this->getPermissionClass()
            ->newQuery()
            ->whereIn('slug', (array) $slug)
            ->each(function ($permission) {
                $this->grantPermission($permission);
            });

        $this->load('permissions');
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    /**
     * Get Permission class.
     *
     * @return \Yajra\Acl\Models\Permission
     */
    public function getPermissionClass(): Permission
    {
        if (!isset($this->permissionClass)) {
            $this->permissionClass = resolve(config('acl.permission'));
        }

        return $this->permissionClass;
    }

    /**
     * Grants the given permission to the user.
     *
     * @param  \Illuminate\Support\Collection|\Illuminate\Database\Eloquent\Model|array  $id
     * @param  array  $attributes
     * @param  bool  $touch
     * @return void
     */
    public function grantPermission($id, array $attributes = [], $touch = true)
    {
        $this->permissions()->attach($id, $attributes, $touch);
        $this->load('permissions');
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    /**
     * Get related permissions.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function permissions(): BelongsToMany
    {
        return $this->belongsToMany(config('acl.permission', Permission::class))->withTimestamps();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    /**
     * Grant user permissions by resource.
     *
     * @param  string|array  $resource
     */
    public function grantPermissionByResource($resource)
    {
        $this->getPermissionClass()
            ->newQuery()
            ->whereIn('resource', (array) $resource)
            ->each(function ($permission) {
                $this->grantPermission($permission);
            });

        $this->load('permissions');
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    /**
     * Revokes the given permission from the user.
     *
     * @param  mixed  $ids
     * @param  bool  $touch
     * @return int
     */
    public function revokePermission($ids = null, $touch = true): int
    {
        return $this->permissions()->detach($ids, $touch);
    }

    /**
     * Syncs the given permission(s) with the user.
     *
     * @param  \Illuminate\Support\Collection|\Illuminate\Database\Eloquent\Model|array  $ids
     * @param  bool  $detaching
     * @return array
     */
    public function syncPermissions($ids, $detaching = true): array
    {
        return $this->permissions()->sync($ids, $detaching);
    }

    /**
     * Revokes all permissions from the user.
     *
     * @return int
     */
    public function revokeAllPermissions(): int
    {
        return $this->permissions()->detach();
    }

    /**
     * Get all user permissions slug.
     *
     * @return array|null
     */
    public function getPermissions(): array
    {
        $rolePermissions = $this->getRolePermissions();

        $userPermissions = $this->permissions->pluck('slug')->toArray();

        return collect($userPermissions)->merge($rolePermissions)->unique()->toArray();
    }
}


1			<?php
2
3			namespace Yajra\Acl\Traits;
4
5			use Illuminate\Database\Eloquent\Relations\BelongsToMany;
6			use Yajra\Acl\Models\Permission;
7
8			/**
9			* @mixin \Illuminate\Database\Eloquent\Model
10			* @property Permission[]\|\Illuminate\Database\Eloquent\Collection $permissions
11			*/
12			trait HasRoleAndPermission
13			{
14			use HasRole {
15			HasRole::getPermissions as getRolePermissions;
16			}
17
18			private $permissionClass;
19
20			/**
21			* Grant user permission by slug.
22			*
23			* @param string\|array $slug
24			*/
25			public function grantPermissionBySlug($slug)
26			{
27			$this->getPermissionClass()
28			->newQuery()
29			->whereIn('slug', (array) $slug)
30			->each(function ($permission) {
31			$this->grantPermission($permission);
32			});
33
34			$this->load('permissions');
			0 ignored issues – show Documentation Bug introduced 2021-04-17 09:15 UTC by Report Bug Copy Issue Report The method `load` does not exist on `object<Yajra\Acl\Traits\HasRoleAndPermission>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
35			}
36
37			/**
38			* Get Permission class.
39			*
40			* @return \Yajra\Acl\Models\Permission
41			*/
42			public function getPermissionClass(): Permission
43			{
44			if (!isset($this->permissionClass)) {
45			$this->permissionClass = resolve(config('acl.permission'));
46			}
47
48			return $this->permissionClass;
49			}
50
51			/**
52			* Grants the given permission to the user.
53			*
54			* @param \Illuminate\Support\Collection\|\Illuminate\Database\Eloquent\Model\|array $id
55			* @param array $attributes
56			* @param bool $touch
57			* @return void
58			*/
59			public function grantPermission($id, array $attributes = [], $touch = true)
60			{
61			$this->permissions()->attach($id, $attributes, $touch);
62			$this->load('permissions');
			0 ignored issues – show Documentation Bug introduced 2021-04-17 09:15 UTC by Report Bug Copy Issue Report The method `load` does not exist on `object<Yajra\Acl\Traits\HasRoleAndPermission>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
63			}
64
65			/**
66			* Get related permissions.
67			*
68			* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
69			*/
70			public function permissions(): BelongsToMany
71			{
72			return $this->belongsToMany(config('acl.permission', Permission::class))->withTimestamps();
			0 ignored issues – show Documentation Bug introduced 2021-04-17 06:50 UTC by Report Bug Copy Issue Report The method `belongsToMany` does not exist on `object<Yajra\Acl\Traits\HasRoleAndPermission>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
73			}
74
75			/**
76			* Grant user permissions by resource.
77			*
78			* @param string\|array $resource
79			*/
80			public function grantPermissionByResource($resource)
81			{
82			$this->getPermissionClass()
83			->newQuery()
84			->whereIn('resource', (array) $resource)
85			->each(function ($permission) {
86			$this->grantPermission($permission);
87			});
88
89			$this->load('permissions');
			0 ignored issues – show Documentation Bug introduced 2021-04-17 09:15 UTC by Report Bug Copy Issue Report The method `load` does not exist on `object<Yajra\Acl\Traits\HasRoleAndPermission>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
90			}
91
92			/**
93			* Revokes the given permission from the user.
94			*
95			* @param mixed $ids
96			* @param bool $touch
97			* @return int
98			*/
99			public function revokePermission($ids = null, $touch = true): int
100			{
101			return $this->permissions()->detach($ids, $touch);
102			}
103
104			/**
105			* Syncs the given permission(s) with the user.
106			*
107			* @param \Illuminate\Support\Collection\|\Illuminate\Database\Eloquent\Model\|array $ids
108			* @param bool $detaching
109			* @return array
110			*/
111			public function syncPermissions($ids, $detaching = true): array
112			{
113			return $this->permissions()->sync($ids, $detaching);
114			}
115
116			/**
117			* Revokes all permissions from the user.
118			*
119			* @return int
120			*/
121			public function revokeAllPermissions(): int
122			{
123			return $this->permissions()->detach();
124			}
125
126			/**
127			* Get all user permissions slug.
128			*
129			* @return array\|null
130			*/
131			public function getPermissions(): array
132			{
133			$rolePermissions = $this->getRolePermissions();
			0 ignored issues – show Bug introduced 2021-04-17 06:50 UTC by Report Bug Copy Issue Report The method `getRolePermissions()` does not exist on `Yajra\Acl\Traits\HasRoleAndPermission`. Did you maybe mean `permissions()`? 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...
134			$userPermissions = $this->permissions->pluck('slug')->toArray();
135
136			return collect($userPermissions)->merge($rolePermissions)->unique()->toArray();
137			}
138			}
139

yajra / laravel-acl

Pull Request — master (#38)

HasRoleAndPermission::grantPermissionBySlug() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like