Completed
Pull Request — master (#1336)
by
unknown
01:16
created

HasRoles::getRoleClass()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 8

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
nc 2
nop 0
dl 0
loc 8
rs 10
c 0
b 0
f 0
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 by
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 by
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 by
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

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. 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(config('permission.table_names.roles').'.guard_name', $guard);
122
123
            return $query->where(function ($query) use ($roles) {
124
                foreach ($roles as $role) {
125
                    $column = is_numeric($role) ? 'id' : 'name';
126
                    $query->orWhere(config('permission.table_names.roles').".{$column}", $role);
127
                }
128
            });
129
        });
130
    }
131
132
    /**
133
     * Assign the given role to the model.
134
     *
135
     * @param array|string|\Spatie\Permission\Contracts\Role ...$roles
136
     *
137
     * @return $this
138
     */
139 View Code Duplication
    public function assignRole(...$roles)
0 ignored issues
show
Duplication introduced by
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...
140
    {
141
        $roles = collect($roles)
142
            ->flatten()
143
            ->map(function ($role) {
144
                if (empty($role)) {
145
                    return false;
146
                }
147
148
                return $this->getStoredRole($role);
149
            })
150
            ->filter(function ($role) {
151
                return $role instanceof Role;
152
            })
153
            ->each(function ($role) {
154
                $this->ensureModelSharesGuard($role);
155
            })
156
            ->map->id
157
            ->all();
158
159
        $model = $this->getModel();
0 ignored issues
show
Bug introduced by
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...
160
161
        if ($model->exists) {
162
            $this->roles()->sync($roles, false);
163
            $model->load('roles');
164
        } else {
165
            $class = \get_class($model);
166
167
            $class::saved(
168
                function ($object) use ($roles, $model) {
169
                    static $modelLastFiredOn;
170
                    if ($modelLastFiredOn !== null && $modelLastFiredOn === $model) {
171
                        return;
172
                    }
173
                    $object->roles()->sync($roles, false);
174
                    $object->load('roles');
175
                    $modelLastFiredOn = $object;
176
                });
177
        }
178
179
        $this->forgetCachedPermissions();
180
181
        return $this;
182
    }
183
184
    /**
185
     * Revoke the given role from the model.
186
     *
187
     * @param string|\Spatie\Permission\Contracts\Role $role
188
     */
189
    public function removeRole($role)
190
    {
191
        $this->roles()->detach($this->getStoredRole($role));
192
193
        $this->load('roles');
0 ignored issues
show
Bug introduced by
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...
194
195
        $this->forgetCachedPermissions();
196
197
        return $this;
198
    }
199
200
    /**
201
     * Remove all current roles and set the given ones.
202
     *
203
     * @param  array|\Spatie\Permission\Contracts\Role|string  ...$roles
204
     *
205
     * @return $this
206
     */
207
    public function syncRoles(...$roles)
208
    {
209
        $this->roles()->detach();
210
211
        return $this->assignRole($roles);
212
    }
213
214
    /**
215
     * Determine if the model has (one of) the given role(s).
216
     *
217
     * @param string|int|array|\Spatie\Permission\Contracts\Role|\Illuminate\Support\Collection $roles
218
     * @param string|null $guard
219
     * @return bool
220
     */
221
    public function hasRole($roles, string $guard = null): bool
222
    {
223 View Code Duplication
        if (is_string($roles) && false !== strpos($roles, '|')) {
0 ignored issues
show
Duplication introduced by
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...
224
            $roles = $this->convertPipeToArray($roles);
225
        }
226
227 View Code Duplication
        if (is_string($roles)) {
0 ignored issues
show
Duplication introduced by
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...
228
            return $guard
229
                ? $this->roles->where('guard_name', $guard)->contains('name', $roles)
0 ignored issues
show
Bug introduced by
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...
230
                : $this->roles->contains('name', $roles);
231
        }
232
233 View Code Duplication
        if (is_int($roles)) {
0 ignored issues
show
Duplication introduced by
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...
234
            return $guard
235
                ? $this->roles->where('guard_name', $guard)->contains('id', $roles)
236
                : $this->roles->contains('id', $roles);
237
        }
238
239
        if ($roles instanceof Role) {
240
            return $this->roles->contains('id', $roles->id);
0 ignored issues
show
Bug introduced by
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

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
241
        }
242
243
        if (is_array($roles)) {
244
            foreach ($roles as $role) {
245
                if ($this->hasRole($role, $guard)) {
246
                    return true;
247
                }
248
            }
249
250
            return false;
251
        }
252
253
        return $roles->intersect($guard ? $this->roles->where('guard_name', $guard) : $this->roles)->isNotEmpty();
254
    }
255
256
    /**
257
     * Determine if the model has any of the given role(s).
258
     *
259
     * Alias to hasRole() but without Guard controls
260
     *
261
     * @param string|int|array|\Spatie\Permission\Contracts\Role|\Illuminate\Support\Collection $roles
262
     *
263
     * @return bool
264
     */
265
    public function hasAnyRole(...$roles): bool
266
    {
267
        return $this->hasRole($roles);
268
    }
269
270
    /**
271
     * Determine if the model has all of the given role(s).
272
     *
273
     * @param  string|array|\Spatie\Permission\Contracts\Role|\Illuminate\Support\Collection  $roles
274
     * @param  string|null  $guard
275
     * @return bool
276
     */
277
    public function hasAllRoles($roles, string $guard = null): bool
278
    {
279 View Code Duplication
        if (is_string($roles) && false !== strpos($roles, '|')) {
0 ignored issues
show
Duplication introduced by
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...
280
            $roles = $this->convertPipeToArray($roles);
281
        }
282
283 View Code Duplication
        if (is_string($roles)) {
0 ignored issues
show
Duplication introduced by
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...
284
            return $guard
285
                ? $this->roles->where('guard_name', $guard)->contains('name', $roles)
286
                : $this->roles->contains('name', $roles);
287
        }
288
289
        if ($roles instanceof Role) {
290
            return $this->roles->contains('id', $roles->id);
0 ignored issues
show
Bug introduced by
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

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
291
        }
292
293
        $roles = collect()->make($roles)->map(function ($role) {
294
            return $role instanceof Role ? $role->name : $role;
0 ignored issues
show
Bug introduced by
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

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
295
        });
296
297
        return $roles->intersect(
298
            $guard
299
                ? $this->roles->where('guard_name', $guard)->pluck('name')
300
                : $this->getRoleNames()) == $roles;
301
    }
302
303
    /**
304
     * Return all permissions directly coupled to the model.
305
     */
306
    public function getDirectPermissions(): Collection
307
    {
308
        return $this->permissions;
0 ignored issues
show
Bug introduced by
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...
309
    }
310
311
    public function getRoleNames(): Collection
312
    {
313
        return $this->roles->pluck('name');
314
    }
315
316
    protected function getStoredRole($role): Role
317
    {
318
        $roleClass = $this->getRoleClass();
319
320
        if (is_numeric($role)) {
321
            return $roleClass->findById($role, $this->getDefaultGuardName());
322
        }
323
324
        if (is_string($role)) {
325
            return $roleClass->findByName($role, $this->getDefaultGuardName());
326
        }
327
328
        return $role;
329
    }
330
331
    protected function convertPipeToArray(string $pipeString)
332
    {
333
        $pipeString = trim($pipeString);
334
335
        if (strlen($pipeString) <= 2) {
336
            return $pipeString;
337
        }
338
339
        $quoteCharacter = substr($pipeString, 0, 1);
340
        $endCharacter = substr($quoteCharacter, -1, 1);
341
342
        if ($quoteCharacter !== $endCharacter) {
343
            return explode('|', $pipeString);
344
        }
345
346
        if (! in_array($quoteCharacter, ["'", '"'])) {
347
            return explode('|', $pipeString);
348
        }
349
350
        return explode('|', trim($pipeString, $quoteCharacter));
351
    }
352
}
353