-
-
Notifications
You must be signed in to change notification settings - Fork 88
Expand file tree
/
Copy pathAction.php
More file actions
246 lines (219 loc) · 5.27 KB
/
Copy pathAction.php
File metadata and controls
246 lines (219 loc) · 5.27 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
<?php
/**
* This file is part of CaptainHook
*
* (c) Sebastian Feldmann <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace CaptainHook\App\Config;
use CaptainHook\App\Config;
/**
* Class Action
*
* @package CaptainHook
* @author Sebastian Feldmann <[email protected]>
* @link https://github.com/captainhook-git/captainhook
* @since Class available since Release 0.9.0
*/
class Action
{
/**
* Action php class, php static method, or cli script
*
* @var string
*/
private string $action;
/**
* Map of options name => value
*
* @var \CaptainHook\App\Config\Options
*/
private Options $options;
/**
* List of action conditions
*
* @var \CaptainHook\App\Config\Condition[]
*/
private array $conditions = [];
/**
* Action settings
*
* @var array<string, mixed>
*/
private array $settings = [];
/**
* List of available settings
*
* @var string[]
*/
private static array $availableSettings = [
Config\Settings::ALLOW_FAILURE,
Config\Settings::LABEL
];
/**
* Indicates if an action config was included from another file
*
* @var bool
*/
private bool $isIncluded = false;
/**
* Action constructor
*
* @param string $action
* @param array<string, mixed> $options
* @param array<string, mixed> $conditions
* @param array<string, mixed> $settings
*/
public function __construct(string $action, array $options = [], array $conditions = [], array $settings = [])
{
$this->action = $action;
$this->setupOptions($options);
$this->setupConditions($conditions);
$this->setupSettings($settings);
}
/**
* Setup options
*
* @param array<string, mixed> $options
*/
private function setupOptions(array $options): void
{
$this->options = new Options($options);
}
/**
* Setup action conditions
*
* @param array<string, array<string, mixed>> $conditions
*/
private function setupConditions(array $conditions): void
{
foreach ($conditions as $condition) {
$this->conditions[] = new Condition($condition['exec'], $condition['args'] ?? []);
}
}
/**
* Setting up the action settings
*
* @param array<string, mixed> $settings
* @return void
*/
private function setupSettings(array $settings): void
{
foreach (self::$availableSettings as $setting) {
if (isset($settings[$setting])) {
$this->settings[$setting] = $settings[$setting];
}
}
}
/**
* Marks an action config as included
*
* @return void
*/
public function markIncluded(): void
{
$this->isIncluded = true;
}
/**
* Check if an action config was included
*
* @return bool
*/
public function isIncluded(): bool
{
return $this->isIncluded;
}
/**
* Indicates if the action can fail without stopping the git operation
*
* @param bool $default
* @return bool
*/
public function isFailureAllowed(bool $default = false): bool
{
return (bool) ($this->settings[Config\Settings::ALLOW_FAILURE] ?? $default);
}
/**
* Indicates if a label is set
*
* @return bool
*/
public function hasLabel(): bool
{
return isset($this->settings[Config\Settings::LABEL]);
}
/**
* Return the label or the action if no label is set
*
* @return string
*/
public function getLabel(): string
{
return (string) ($this->settings[Config\Settings::LABEL] ?? $this->getAction());
}
/**
* Action getter
*
* @return string
*/
public function getAction(): string
{
return $this->action;
}
/**
* Return option map
*
* @return \CaptainHook\App\Config\Options
*/
public function getOptions(): Options
{
return $this->options;
}
/**
* Return condition configurations
*
* @return \CaptainHook\App\Config\Condition[]
*/
public function getConditions(): array
{
return $this->conditions;
}
/**
* Return config data
*
* @return array<string, mixed>
*/
public function getJsonData(): array
{
$data = [
'action' => $this->action
];
$options = $this->options->getAll();
if (!empty($options)) {
$data['options'] = $options;
}
$conditions = $this->getConditionJsonData();
if (!empty($conditions)) {
$data['conditions'] = $conditions;
}
if (!empty($this->settings)) {
$data['config'] = $this->settings;
}
return $data;
}
/**
* Return conditions json data
*
* @return array<int, mixed>
*/
private function getConditionJsonData(): array
{
$json = [];
foreach ($this->conditions as $condition) {
$json[] = $condition->getJsonData();
}
return $json;
}
}