1 | <?php namespace Usman\Guardian\AccessControl; |
||
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() |
||
14 | |||
15 | /** |
||
16 | * Checks for a role |
||
17 | * |
||
18 | * @param string $roleName |
||
19 | * @return boolean |
||
20 | */ |
||
21 | public function hasRole($roleName) |
||
32 | |||
33 | /** |
||
34 | * Checks for any role |
||
35 | * |
||
36 | * @param array $roleNames |
||
37 | * @return boolean |
||
38 | */ |
||
39 | public function hasAnyRole(array $roleNames) |
||
47 | |||
48 | /** |
||
49 | * Checks for all roles |
||
50 | * |
||
51 | * @param array $roleNames |
||
52 | * @return boolean |
||
53 | */ |
||
54 | public function hasAllRoles(array $roleNames) |
||
62 | |||
63 | /** |
||
64 | * Checks if a user has a capability |
||
65 | * |
||
66 | * @param string $capabilityName |
||
67 | * @return boolean |
||
68 | */ |
||
69 | public function hasCapability($capabilityName) |
||
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) |
||
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) |
||
114 | |||
115 | } |
||
116 |
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
The trait
Idable
provides a methodequalsId
that in turn relies on the methodgetId()
. 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.