1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace Chriscreates\Projects\Traits; |
4
|
|
|
|
5
|
|
|
use Illuminate\Database\Eloquent\Relations\BelongsToMany; |
6
|
|
|
|
7
|
|
|
trait HasUsers |
8
|
|
|
{ |
9
|
|
|
/** |
10
|
|
|
* @return Illuminate\Database\Eloquent\Relations\BelongsToMany |
11
|
|
|
*/ |
12
|
|
|
public function users() : BelongsToMany |
13
|
|
|
{ |
14
|
|
|
return $this->belongsToMany( |
|
|
|
|
15
|
|
|
get_class(user_model()), |
16
|
|
|
'project_users', |
17
|
|
|
'user_id', |
18
|
|
|
'project_id' |
19
|
|
|
); |
20
|
|
|
} |
21
|
|
|
|
22
|
|
|
/** |
23
|
|
|
* Add a user to the current Project. |
24
|
|
|
* |
25
|
|
|
* @param string|int|\Illuminate\Database\Eloquent\Model $user |
26
|
|
|
* @param array $pivot_columns |
27
|
|
|
* @return self |
28
|
|
|
*/ |
29
|
|
|
public function addUser($user, array $pivot_columns = []) : self |
30
|
|
|
{ |
31
|
|
|
return $this->addUsers([$user], $pivot_columns); |
32
|
|
|
} |
33
|
|
|
|
34
|
|
|
/** |
35
|
|
|
* Add one or multiple users to the current Project. |
36
|
|
|
* |
37
|
|
|
* @param array $users |
38
|
|
|
* @param array $pivot_columns |
39
|
|
|
* @return self |
40
|
|
|
*/ |
41
|
|
View Code Duplication |
public function addUsers(array $users = [], array $pivot_columns = []) : self |
|
|
|
|
42
|
|
|
{ |
43
|
|
|
$keyed = collect($users) |
44
|
|
|
->mapWithKeys(function ($user) use ($pivot_columns) { |
45
|
|
|
return [ |
46
|
|
|
is_a($user, user_model()) ? $user->id : $user => $pivot_columns, |
47
|
|
|
]; |
48
|
|
|
})->toArray(); |
49
|
|
|
|
50
|
|
|
$this->users()->syncWithoutDetaching($keyed); |
51
|
|
|
|
52
|
|
|
$this->load('users'); |
|
|
|
|
53
|
|
|
|
54
|
|
|
$this->refresh('users'); |
|
|
|
|
55
|
|
|
|
56
|
|
|
return $this; |
57
|
|
|
} |
58
|
|
|
|
59
|
|
|
/** |
60
|
|
|
* Remove the given user from the current Project |
61
|
|
|
* |
62
|
|
|
* @param string|int|\Illuminate\Database\Eloquent\Model $user |
63
|
|
|
* @return self |
64
|
|
|
*/ |
65
|
|
|
public function removeUser($user) : self |
66
|
|
|
{ |
67
|
|
|
return $this->users()->detach(is_a($user, user_model()) ? $user->id : $user); |
68
|
|
|
} |
69
|
|
|
|
70
|
|
|
/** |
71
|
|
|
* Remove one or multiple users from the current Project |
72
|
|
|
* |
73
|
|
|
* @param array $users |
74
|
|
|
* @return self |
75
|
|
|
*/ |
76
|
|
View Code Duplication |
public function removeUsers(array $users = []) : self |
|
|
|
|
77
|
|
|
{ |
78
|
|
|
$keyed = collect($users) |
79
|
|
|
->map(function ($user) { |
80
|
|
|
return is_a($user, user_model()) ? $user->id : $user; |
81
|
|
|
})->toArray(); |
82
|
|
|
|
83
|
|
|
$this->users()->detach($keyed); |
84
|
|
|
|
85
|
|
|
$this->load('users'); |
|
|
|
|
86
|
|
|
|
87
|
|
|
$this->refresh('users'); |
|
|
|
|
88
|
|
|
|
89
|
|
|
return $this; |
90
|
|
|
} |
91
|
|
|
|
92
|
|
|
/** |
93
|
|
|
* Check if the given user is on the current Project |
94
|
|
|
* |
95
|
|
|
* @param string|int|\Illuminate\Database\Eloquent\Model $user |
96
|
|
|
* @return bool |
97
|
|
|
*/ |
98
|
|
|
public function hasUser($user) : bool |
99
|
|
|
{ |
100
|
|
|
return $this->users->contains('id', is_a($user, user_model()) ? $user->id : $user); |
|
|
|
|
101
|
|
|
} |
102
|
|
|
} |
103
|
|
|
|
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.