AccessControlTrait::roles()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 0
1
<?php namespace Usman\Guardian\AccessControl;
2
3
trait AccessControlTrait {
4
5
    /**
6
     * Defines a one to many relation with the roles table
7
     * 
8
     * @return Illuminate\Database\Eloquent\Relations\BelongsToMany
9
     */
10
    public function roles()
11
    {
12
        return $this->belongsToMany(config('guardian.roleModel'));
0 ignored issues
show
Bug introduced by
It seems like belongsToMany() 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...
13
    }
14
    
15
    /**
16
     * Checks for a role
17
     * 
18
     * @param  string  $roleName
19
     * @return boolean
20
     */
21
    public function hasRole($roleName)
22
    {
23
        foreach($this->roles as $role)
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...
24
        {
25
            if(strtolower($role->role_name) == strtolower($roleName))
26
            {
27
                return true;
28
            }
29
        }
30
        return false;
31
    }
32
33
    /**
34
     * Checks for any role
35
     * 
36
     * @param  array   $roleNames
37
     * @return boolean
38
     */
39
    public function hasAnyRole(array $roleNames)
40
    {
41
        foreach($roleNames as $roleName)
42
        {
43
            if($this->hasRole($roleName)) return true;
44
        }
45
        return false;
46
    }
47
48
    /**
49
     * Checks for all roles
50
     * 
51
     * @param  array   $roleNames
52
     * @return boolean
53
     */
54
    public function hasAllRoles(array $roleNames)
55
    {
56
        foreach($roleNames as $roleName)
57
        {
58
            if( ! $this->hasRole($roleName)) return false;
59
        }
60
        return true;
61
    }
62
63
    /**
64
     * Checks if a user has a capability
65
     * 
66
     * @param  string  $capabilityName
67
     * @return boolean
68
     */
69
    public function hasCapability($capabilityName)
70
    {
71
        foreach($this->roles as $role)
72
        {
73
            foreach($role->capabilities as $capability)
74
            { 
75
                if(strtolower($capability->capability) == strtolower($capabilityName))
76
                {
77
                    return true;
78
                }
79
            }
80
        }
81
        return false;
82
    }
83
84
    /**
85
     * Checks if a user has any capability
86
     * 
87
     * @param  array   $capabilityNames
88
     * @return boolean
89
     */
90
    public function hasAnyCapability(array $capabilityNames)
91
    {
92
        foreach($capabilityNames as $capabilityName)
93
        {
94
            if($this->hasCapability($capabilityName)) return true;
95
        }
96
        return false;
97
98
    }
99
100
    /**
101
     * Checks if a user has all the capabilities
102
     * 
103
     * @param  array   $capabilityNames
104
     * @return boolean
105
     */
106
    public function hasAllCapabilities(array $capabilityNames)
107
    {
108
        foreach($capabilityNames as $capabilityName)
109
        {
110
            if( ! $this->hasCapability($capabilityName)) return false;
111
        }
112
        return true;
113
    }
114
115
}
116