AuthUserTrait::detachAllRoles() - Code Metrics - Inspection of "Updating the package" - ARCANEDEV/LaravelAuth - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#23)

by ARCANEDEV

created 2017-02-18 21:35 UTC

AuthUserTrait::detachAllRoles() A

↳ Parent: AuthUserTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	10
ccs	6
cts	6
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	6
nc	1
nop	1
crap	1

<?php namespace Arcanedev\LaravelAuth\Models\Traits;

use Arcanedev\LaravelAuth\Events\RoleUser\AttachedRoleUser;
use Arcanedev\LaravelAuth\Events\RoleUser\AttachingRoleUser;
use Arcanedev\LaravelAuth\Events\Users\DetachedRole;
use Arcanedev\LaravelAuth\Events\Users\DetachedRoles;
use Arcanedev\LaravelAuth\Events\Users\DetachingRole;
use Arcanedev\LaravelAuth\Events\Users\DetachingRoles;
use Arcanedev\LaravelAuth\Events\Users\SyncedUserWithRoles;
use Arcanedev\LaravelAuth\Events\Users\SyncingUserWithRoles;
use Arcanedev\LaravelAuth\Models\Permission;
use Arcanedev\LaravelAuth\Models\Role;
use Arcanesoft\Contracts\Auth\Models\Role as RoleContract;
use Illuminate\Database\Eloquent\Collection;

/**
 * Trait     AuthUserTrait
 *
 * @package  Arcanedev\LaravelAuth\Traits
 * @author   ARCANEDEV <[email protected]>
 *
 * @property  \Illuminate\Database\Eloquent\Collection  permissions
 */
trait AuthUserTrait
{
    /* ------------------------------------------------------------------------------------------------
     |  Traits
     | ------------------------------------------------------------------------------------------------
     */
    use AuthRoleTrait;

    /* ------------------------------------------------------------------------------------------------
     |  Getters & Setters
     | ------------------------------------------------------------------------------------------------
     */
    /**
     * Get all user permissions.
     *
     * @return \Illuminate\Database\Eloquent\Collection
     */
    public function getPermissionsAttribute()
    {
        $permissions = new Collection;

        foreach ($this->roles as $role) {
            /** @var Role $role */
            $permissions = $permissions->merge($role->permissions);
        }

        return $permissions;
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */
    /**
     * Attach a role to a user.
     *
     * @param  \Arcanesoft\Contracts\Auth\Models\Role|int  $role
     * @param  bool                                    $reload
     */
    public function attachRole($role, $reload = true)
    {
        if ( ! $this->hasRole($role)) {
            event(new AttachingRoleUser($role, $this));

            $this->roles()->attach($role);
            $this->loadRoles($reload);
            event(new AttachedRoleUser($role, $this));

        }
    }

    /**
     * Sync the roles by its slugs.
     *
     * @param  array  $slugs
     * @param  bool   $reload
     *
     * @return array
     */
    public function syncRoles(array $slugs, $reload = true)
    {
        /** @var \Illuminate\Database\Eloquent\Collection $roles */
        $roles  = app(RoleContract::class)->whereIn('slug', $slugs)->get();

        event(new SyncingUserWithRoles($this, $roles));
        $synced = $this->roles()->sync($roles->pluck('id'));
        event(new SyncedUserWithRoles($this, $roles, $synced));

        $this->loadRoles($reload);

        return $synced;
    }

    /**
     * Detach a role from a user.
     *
     * @param  \Arcanesoft\Contracts\Auth\Models\Role|int  $role
     * @param  bool                                        $reload
     *
     * @return int
     */
    public function detachRole($role, $reload = true)
    {
        event(new DetachingRole($this, $role));

        $results = $this->roles()->detach($role);
        event(new DetachedRole($this, $role, $results));


        $this->loadRoles($reload);

        return $results;
    }

    /**
     * Detach all roles from a user.
     *
     * @param  bool  $reload
     *
     * @return int
     */
    public function detachAllRoles($reload = true)
    {
        event(new DetachingRoles($this));
        $results = $this->roles()->detach();
        event(new DetachedRoles($this, $results));

        $this->loadRoles($reload);

        return $results;
    }

    /* -----------------------------------------------------------------
     |  Permission Check Methods
     | -----------------------------------------------------------------
     */
    /**
     * Check if the user has a permission.
     *
     * @param  string  $slug
     *
     * @return bool
     */
    public function may($slug)
    {
        $permissions = $this->permissions->filter(function(Permission $permission) use ($slug) {
            return $permission->slug === str_slug($slug, config('laravel-auth.slug-separator', '.'));
        });

        return ! $permissions->isEmpty();
    }

    /**
     * Check if the user has at least one permission.
     *
     * @param  array  $permissions
     * @param  array  $failedPermissions
     *
     * @return bool
     */
    public function mayOne(array $permissions, array &$failedPermissions = [])
    {
        foreach ($permissions as $permission) {
            if ( ! $this->may($permission))
                $failedPermissions[] = $permission;
        }

        return count($permissions) !== count($failedPermissions);
    }

    /**
     * Check if the user has all permissions.
     *
     * @param  array  $permissions
     * @param  array  $failedPermissions
     *
     * @return bool
     */
    public function mayAll(array $permissions, array &$failedPermissions = [])
    {
        $this->mayOne($permissions, $failedPermissions);

        return count($failedPermissions) === 0;
    }
}


1		<?php namespace Arcanedev\LaravelAuth\Models\Traits;
2
3		use Arcanedev\LaravelAuth\Events\RoleUser\AttachedRoleUser;
4		use Arcanedev\LaravelAuth\Events\RoleUser\AttachingRoleUser;
5		use Arcanedev\LaravelAuth\Events\Users\DetachedRole;
6		use Arcanedev\LaravelAuth\Events\Users\DetachedRoles;
7		use Arcanedev\LaravelAuth\Events\Users\DetachingRole;
8		use Arcanedev\LaravelAuth\Events\Users\DetachingRoles;
9		use Arcanedev\LaravelAuth\Events\Users\SyncedUserWithRoles;
10		use Arcanedev\LaravelAuth\Events\Users\SyncingUserWithRoles;
11		use Arcanedev\LaravelAuth\Models\Permission;
12		use Arcanedev\LaravelAuth\Models\Role;
13		use Arcanesoft\Contracts\Auth\Models\Role as RoleContract;
14		use Illuminate\Database\Eloquent\Collection;
15
16		/**
17		* Trait AuthUserTrait
18		*
19		* @package Arcanedev\LaravelAuth\Traits
20		* @author ARCANEDEV <[email protected]>
21		*
22		* @property \Illuminate\Database\Eloquent\Collection permissions
23		*/
24		trait AuthUserTrait
25		{
26		/* ------------------------------------------------------------------------------------------------
27		\| Traits
28		\| ------------------------------------------------------------------------------------------------
29		*/
30		use AuthRoleTrait;
31
32		/* ------------------------------------------------------------------------------------------------
33		\| Getters & Setters
34		\| ------------------------------------------------------------------------------------------------
35		*/
36		/**
37		* Get all user permissions.
38		*
39		* @return \Illuminate\Database\Eloquent\Collection
40		*/
41	9	public function getPermissionsAttribute()
42		{
43	9	$permissions = new Collection;
44
45	9	foreach ($this->roles as $role) {
46		/** @var Role $role */
47	9	$permissions = $permissions->merge($role->permissions);
48		}
49
50	9	return $permissions;
51		}
52
53		/* -----------------------------------------------------------------
54		\| Main Methods
55		\| -----------------------------------------------------------------
56		*/
57		/**
58		* Attach a role to a user.
59		*
60		* @param \Arcanesoft\Contracts\Auth\Models\Role\|int $role
61		* @param bool $reload
62		*/
63	27	public function attachRole($role, $reload = true)
64		{
65	27	if ( ! $this->hasRole($role)) {
66	27	event(new AttachingRoleUser($role, $this));
		0 ignored issues – show Bug introduced 2017-02-18 21:43 UTC by Report Bug Copy Issue Report It seems like `$role` defined by parameter `$role` on line 63 can also be of type `integer`; however, `Arcanedev\LaravelAuth\Ev...RoleUser::__construct()` does only seem to accept `object<Arcanesoft\Contracts\Auth\Models\Role>`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
67	27	$this->roles()->attach($role);
68	27	$this->loadRoles($reload);
69	27	event(new AttachedRoleUser($role, $this));
		0 ignored issues – show Bug introduced 2017-02-18 21:43 UTC by Report Bug Copy Issue Report It seems like `$role` defined by parameter `$role` on line 63 can also be of type `integer`; however, `Arcanedev\LaravelAuth\Ev...RoleUser::__construct()` does only seem to accept `object<Arcanesoft\Contracts\Auth\Models\Role>`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
70		}
71	27	}
72
73		/**
74		* Sync the roles by its slugs.
75		*
76		* @param array $slugs
77		* @param bool $reload
78		*
79		* @return array
80		*/
81	3	public function syncRoles(array $slugs, $reload = true)
82		{
83		/** @var \Illuminate\Database\Eloquent\Collection $roles */
84	3	$roles = app(RoleContract::class)->whereIn('slug', $slugs)->get();
85
86	3	event(new SyncingUserWithRoles($this, $roles));
87	3	$synced = $this->roles()->sync($roles->pluck('id'));
88	3	event(new SyncedUserWithRoles($this, $roles, $synced));
89
90	3	$this->loadRoles($reload);
91
92	3	return $synced;
93		}
94
95		/**
96		* Detach a role from a user.
97		*
98		* @param \Arcanesoft\Contracts\Auth\Models\Role\|int $role
99		* @param bool $reload
100		*
101		* @return int
102		*/
103	3	public function detachRole($role, $reload = true)
104		{
105	3	event(new DetachingRole($this, $role));
		0 ignored issues – show Bug introduced 2017-02-18 21:43 UTC by Report Bug Copy Issue Report It seems like `$role` defined by parameter `$role` on line 103 can also be of type `integer`; however, `Arcanedev\LaravelAuth\Ev...hingRole::__construct()` does only seem to accept `object<Arcanesoft\Contracts\Auth\Models\Role>`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
106	3	$results = $this->roles()->detach($role);
107	3	event(new DetachedRole($this, $role, $results));
		0 ignored issues – show Bug introduced 2017-02-18 21:43 UTC by Report Bug Copy Issue Report It seems like `$role` defined by parameter `$role` on line 103 can also be of type `integer`; however, `Arcanedev\LaravelAuth\Ev...chedRole::__construct()` does only seem to accept `object<Arcanesoft\Contracts\Auth\Models\Role>`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
108
109	3	$this->loadRoles($reload);
110
111	3	return $results;
112		}
113
114		/**
115		* Detach all roles from a user.
116		*
117		* @param bool $reload
118		*
119		* @return int
120		*/
121	3	public function detachAllRoles($reload = true)
122		{
123	3	event(new DetachingRoles($this));
124	3	$results = $this->roles()->detach();
125	3	event(new DetachedRoles($this, $results));
126
127	3	$this->loadRoles($reload);
128
129	3	return $results;
130		}
131
132		/* -----------------------------------------------------------------
133		\| Permission Check Methods
134		\| -----------------------------------------------------------------
135		*/
136		/**
137		* Check if the user has a permission.
138		*
139		* @param string $slug
140		*
141		* @return bool
142		*/
143		public function may($slug)
144		{
145	9	$permissions = $this->permissions->filter(function(Permission $permission) use ($slug) {
146	9	return $permission->slug === str_slug($slug, config('laravel-auth.slug-separator', '.'));
147	9	});
148
149	9	return ! $permissions->isEmpty();
150		}
151
152		/**
153		* Check if the user has at least one permission.
154		*
155		* @param array $permissions
156		* @param array $failedPermissions
157		*
158		* @return bool
159		*/
160	6	public function mayOne(array $permissions, array &$failedPermissions = [])
161		{
162	6	foreach ($permissions as $permission) {
163	6	if ( ! $this->may($permission))
164	6	$failedPermissions[] = $permission;
165		}
166
167	6	return count($permissions) !== count($failedPermissions);
168		}
169
170		/**
171		* Check if the user has all permissions.
172		*
173		* @param array $permissions
174		* @param array $failedPermissions
175		*
176		* @return bool
177		*/
178	3	public function mayAll(array $permissions, array &$failedPermissions = [])
179		{
180	3	$this->mayOne($permissions, $failedPermissions);
181
182	3	return count($failedPermissions) === 0;
183		}
184		}
185

ARCANEDEV / LaravelAuth

Pull Request — master (#23)

AuthUserTrait::detachAllRoles() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like