1
|
|
|
<?php |
2
|
|
|
|
|
|
|
|
3
|
|
|
namespace BristolSU\Module\AssignRoles\CompletionConditions; |
4
|
|
|
|
5
|
|
|
use BristolSU\ControlDB\Contracts\Models\Group; |
6
|
|
|
use BristolSU\ControlDB\Contracts\Models\Role; |
7
|
|
|
use BristolSU\ControlDB\Contracts\Repositories\Position; |
8
|
|
|
use BristolSU\ControlDB\Contracts\Repositories\Role as RoleRepository; |
9
|
|
|
use BristolSU\Module\AssignRoles\Fields\RequiredPositions; |
10
|
|
|
use BristolSU\Module\AssignRoles\Support\LogicRoleRepository; |
11
|
|
|
use BristolSU\Module\AssignRoles\Support\RequiredSettingRetrieval; |
12
|
|
|
use BristolSU\Module\AssignRoles\Support\SettingRetrievalException; |
13
|
|
|
use BristolSU\Support\ActivityInstance\ActivityInstance; |
14
|
|
|
use BristolSU\Support\Completion\Contracts\CompletionCondition; |
15
|
|
|
use BristolSU\Support\Logic\Contracts\Audience\LogicAudience; |
16
|
|
|
use BristolSU\Support\Logic\Contracts\LogicRepository; |
17
|
|
|
use BristolSU\Support\Logic\Facade\LogicTester; |
18
|
|
|
use BristolSU\Support\ModuleInstance\Contracts\ModuleInstance; |
19
|
|
|
use FormSchema\Generator\Field; |
20
|
|
|
use FormSchema\Schema\Form; |
21
|
|
|
use Illuminate\Support\Collection; |
22
|
|
|
|
23
|
|
|
class RequiredPositionsFilled extends CompletionCondition |
|
|
|
|
24
|
|
|
{ |
25
|
|
|
|
26
|
|
|
/** |
|
|
|
|
27
|
|
|
* @var RoleRepository |
28
|
|
|
*/ |
29
|
|
|
private $roleRepository; |
|
|
|
|
30
|
|
|
|
31
|
|
|
public function __construct(string $moduleAlias, RoleRepository $roleRepository) |
|
|
|
|
32
|
|
|
{ |
33
|
|
|
parent::__construct($moduleAlias); |
34
|
|
|
$this->roleRepository = $roleRepository; |
35
|
|
|
} |
36
|
|
|
|
37
|
|
|
/** |
|
|
|
|
38
|
|
|
* @inheritDoc |
39
|
|
|
*/ |
|
|
|
|
40
|
|
|
public function isComplete($settings, ActivityInstance $activityInstance, ModuleInstance $moduleInstance): bool |
41
|
|
|
{ |
42
|
|
|
try { |
43
|
|
|
$remainingPositions = $this->positionsStillToFill($settings, $activityInstance, $moduleInstance); |
44
|
|
|
} catch (SettingRetrievalException $e) { |
45
|
|
|
return false; |
46
|
|
|
} |
47
|
|
|
|
48
|
|
|
return count($remainingPositions) === 0; |
|
|
|
|
49
|
|
|
} |
50
|
|
|
|
51
|
|
|
public function percentage($settings, ActivityInstance $activityInstance, ModuleInstance $moduleInstance): int |
|
|
|
|
52
|
|
|
{ |
53
|
|
|
$group = $this->getGroup($activityInstance); |
54
|
|
|
|
55
|
|
|
try { |
56
|
|
|
$requiredPositions = $this->getRequiredPositions($settings, $group); |
57
|
|
|
$remainingPositions = $this->positionsStillToFill($settings, $activityInstance, $moduleInstance); |
58
|
|
|
} catch (SettingRetrievalException $e) { |
59
|
|
|
return false; |
|
|
|
|
60
|
|
|
} |
61
|
|
|
|
62
|
|
|
if(count($requiredPositions) === 0) { |
|
|
|
|
63
|
|
|
return 100; |
64
|
|
|
} |
65
|
|
|
|
66
|
|
|
$filled = count($requiredPositions) - count($remainingPositions); |
67
|
|
|
|
68
|
|
|
$percentage = (int) round(($filled/count($requiredPositions)) * 100, 0); |
69
|
|
|
|
70
|
|
|
if($percentage > 100) { |
|
|
|
|
71
|
|
|
return 100; |
72
|
|
|
} |
73
|
|
|
return $percentage; |
74
|
|
|
} |
75
|
|
|
|
76
|
|
|
protected function positionsStillToFill($settings, ActivityInstance $activityInstance, ModuleInstance $moduleInstance) |
|
|
|
|
77
|
|
|
{ |
78
|
|
|
$group = $this->getGroup($activityInstance); |
79
|
|
|
$roles = $this->rolesThroughGroup($group, $moduleInstance)->filter(function(Role $role) { |
|
|
|
|
80
|
|
|
return $role->users()->count() > 0; |
81
|
|
|
}); |
|
|
|
|
82
|
|
|
|
83
|
|
|
return collect($this->getRequiredPositions($settings, $group))->filter(function(int $positionId) use ($roles) { |
|
|
|
|
84
|
|
|
return $roles->filter(function(Role $role) use ($positionId) { |
|
|
|
|
85
|
|
|
return $role->positionId() === $positionId; |
86
|
|
|
})->count() === 0; |
|
|
|
|
87
|
|
|
}); |
|
|
|
|
88
|
|
|
} |
89
|
|
|
|
90
|
|
|
/** |
|
|
|
|
91
|
|
|
* @inheritDoc |
92
|
|
|
*/ |
|
|
|
|
93
|
|
|
public function options(): Form |
94
|
|
|
{ |
95
|
|
|
return \FormSchema\Generator\Form::make()->withField( |
96
|
|
|
Field::make(RequiredPositions::class, 'required') |
97
|
|
|
->label('Required Positions')->featured(true)->required(true) |
98
|
|
|
->default([])->hint('Define which positions are required') |
99
|
|
|
->help('Define the positions that are required for any given logic group') |
100
|
|
|
->logic($this->getLogic()) |
101
|
|
|
->positions($this->getPositions()) |
102
|
|
|
)->getSchema(); |
103
|
|
|
} |
104
|
|
|
|
105
|
|
|
/** |
|
|
|
|
106
|
|
|
* @inheritDoc |
107
|
|
|
*/ |
|
|
|
|
108
|
|
|
public function name(): string |
109
|
|
|
{ |
110
|
|
|
return 'Required Positions are filled'; |
111
|
|
|
} |
112
|
|
|
|
113
|
|
|
/** |
|
|
|
|
114
|
|
|
* @inheritDoc |
115
|
|
|
*/ |
|
|
|
|
116
|
|
|
public function description(): string |
117
|
|
|
{ |
118
|
|
|
return 'Positions that are marked as required for a group have been filled'; |
119
|
|
|
} |
120
|
|
|
|
121
|
|
|
/** |
|
|
|
|
122
|
|
|
* @inheritDoc |
123
|
|
|
*/ |
|
|
|
|
124
|
|
|
public function alias(): string |
125
|
|
|
{ |
126
|
|
|
return 'required_positions_are_filled'; |
127
|
|
|
} |
128
|
|
|
|
129
|
|
|
private function getLogic() |
|
|
|
|
130
|
|
|
{ |
131
|
|
|
try { |
132
|
|
|
return collect(app(LogicRepository::class)->all()); |
133
|
|
|
} catch (\Exception $e) { |
134
|
|
|
return collect(); |
135
|
|
|
} |
136
|
|
|
} |
137
|
|
|
|
138
|
|
|
private function getPositions() |
|
|
|
|
139
|
|
|
{ |
140
|
|
|
try { |
141
|
|
|
return collect(app(Position::class)->all()); |
142
|
|
|
} catch (\Exception $e) { |
143
|
|
|
return collect(); |
144
|
|
|
} |
145
|
|
|
} |
146
|
|
|
|
147
|
|
|
/** |
148
|
|
|
* Get the group from an activity instance |
149
|
|
|
* |
150
|
|
|
* @param ActivityInstance $activityInstance |
|
|
|
|
151
|
|
|
* @return Group|\BristolSU\ControlDB\Models\Group |
|
|
|
|
152
|
|
|
*/ |
153
|
|
|
private function getGroup(ActivityInstance $activityInstance) |
|
|
|
|
154
|
|
|
{ |
155
|
|
|
if($activityInstance->resource_type === 'group') { |
|
|
|
|
156
|
|
|
return $activityInstance->participant(); |
|
|
|
|
157
|
|
|
} |
158
|
|
|
return $activityInstance->participant()->group(); |
|
|
|
|
159
|
|
|
} |
160
|
|
|
|
161
|
|
|
private function getRequiredPositions(array $settings, Group $group) |
|
|
|
|
162
|
|
|
{ |
163
|
|
|
return app(RequiredSettingRetrieval::class)->getSettings($group, $settings); |
164
|
|
|
} |
165
|
|
|
|
166
|
|
|
private function rolesThroughGroup(Group $group, ModuleInstance $moduleInstance) |
|
|
|
|
167
|
|
|
{ |
168
|
|
|
$roles = $group->roles(); |
169
|
|
|
if($this->logicGroupId($moduleInstance) !== null) { |
|
|
|
|
170
|
|
|
$logicGroup = app(LogicRepository::class)->getById($this->logicGroupId($moduleInstance)); |
|
|
|
|
171
|
|
|
return $roles->filter(function(\BristolSU\ControlDB\Contracts\Models\Role $role) use ($moduleInstance, $logicGroup) { |
|
|
|
|
172
|
|
|
return LogicTester::evaluate($logicGroup, null, $role->group(), $role); |
173
|
|
|
})->values(); |
|
|
|
|
174
|
|
|
} |
175
|
|
|
return $roles; |
176
|
|
|
} |
177
|
|
|
|
178
|
|
|
private function logicGroupId(ModuleInstance $moduleInstance) |
|
|
|
|
179
|
|
|
{ |
180
|
|
|
$id = $moduleInstance->setting('logic_group', null); |
181
|
|
|
if($id === null) { |
|
|
|
|
182
|
|
|
return null; |
183
|
|
|
} |
184
|
|
|
return (int) $id; |
185
|
|
|
} |
186
|
|
|
|
187
|
|
|
} |