Repository navigation
Expand file tree
/
Copy pathSetting.php
More file actions
371 lines (318 loc) · 9.23 KB
/
Copy pathSetting.php
File metadata and controls
371 lines (318 loc) · 9.23 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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
<?php
namespace ProcessMaker\Models;
use Carbon\Carbon;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Facades\DB;
use Illuminate\Validation\Rule;
use ProcessMaker\Traits\ExtendedPMQL;
use ProcessMaker\Traits\SerializeToIso8601;
use Spatie\MediaLibrary\HasMedia;
use Spatie\MediaLibrary\InteractsWithMedia;
/**
* Class Settings
*
*
* @property string id
* @property string key
* @property array config
* @property Carbon $updated_at
* @property Carbon $created_at
*
* @OA\Schema(
* schema="settingsEditable",
* @OA\Property(property="key", type="string"),
* @OA\Property(property="config", type="array", @OA\Items(type="object")),
* @OA\Property(property="name", type="string"),
* @OA\Property(property="helper", type="string"),
* @OA\Property(property="group", type="string"),
* @OA\Property(property="format", type="string"),
* @OA\Property(property="hidden", type="boolean"),
* @OA\Property(property="readonly", type="boolean"),
* @OA\Property(property="variables", type="string"),
* @OA\Property(property="sansSerifFont", type="string"),
* ),
* @OA\Schema(
* schema="settings",
* allOf={
* @OA\Schema(ref="#/components/schemas/settingsEditable"),
* @OA\Schema(
* @OA\Property(property="id", type="string", format="id"),
* @OA\Property(property="created_at", type="string", format="date-time"),
* @OA\Property(property="updated_at", type="string", format="date-time"),
* ),
* },
* )
*/
class Setting extends ProcessMakerModel implements HasMedia
{
use ExtendedPMQL;
use InteractsWithMedia;
use SerializeToIso8601;
protected $table = 'settings';
protected $connection = 'processmaker';
public const DISK_CSS = 'settings';
public const COLLECTION_CSS_LOGIN = 'login';
public const COLLECTION_CSS_LOGO = 'logo';
public const COLLECTION_CSS_ICON = 'icon';
public const COLLECTION_CSS_FAVICON = 'favicon';
public const LOGIN_OPTIONS_GROUP = 'Log-In Options';
/**
* The attributes that aren't mass assignable.
*
* @var array
*/
protected $guarded = [
'id',
'created_at',
'updated_at',
];
/**
* The attributes that are mass assignable.
*
* @var array
*/
protected $fillable = [
'key',
'config',
'format',
'name',
'helper',
'group',
'hidden',
'ui',
];
/**
* The attributes that should be cast to native types.
*
* @var array
*/
protected $casts = [
'hidden' => 'boolean',
'readonly' => 'boolean',
'ui' => 'object',
];
/**
* Validation rules
*
* @param null $existing
* @param bool $validateConfig
*
* @return array
*/
public static function rules($existing = null, $validateConfig = false)
{
$unique = Rule::unique('settings')->ignore($existing);
return [
'key' => ['required', $unique],
'config.*' => ($validateConfig ? ['required', 'valid_variable'] : []),
];
}
/**
* @return array
*/
public static function messages()
{
return [
'config.*.valid_variable' => trans('environmentVariables.validation.name.invalid_variable_name'),
];
}
/**
* Get setting by key
*
* @param string $key
*
* @return \ProcessMaker\Models\Setting|null
* @throws \Exception
*/
public static function byKey(string $key)
{
return (new self)->where('key', $key)->first();
}
/**
* Get config by key
*
* @param $key
*
* @return array|null
* @throws \Exception
*/
public static function configByKey($key)
{
$setting = self::byKey($key);
return $setting instanceof self ? $setting->config : null;
}
public function scopeHidden($query)
{
return $query->where('hidden', true);
}
public function scopeNotHidden($query)
{
return $query->where('hidden', false);
}
public function getGroupAttribute()
{
if ($this->attributes['group'] === null) {
return $this->attributes['group'] = 'System';
}
return $this->attributes['group'] = $this->attributes['group'];
}
public function getConfigAttribute()
{
switch ($this->format) {
case 'text':
case 'textarea':
case 'file':
case 'choice':
case 'range':
return $this->attributes['config'] = $this->attributes['config'];
case 'boolean':
return $this->attributes['config'] = (bool) $this->attributes['config'];
case 'object':
if (is_string($this->attributes['config'])) {
return $this->attributes['config'] = json_decode($this->attributes['config']);
} elseif (is_object($this->attributes['config'])) {
return $this->attributes['config'];
}
case 'array':
case 'checkboxes':
default:
if (is_string($this->attributes['config'])) {
return $this->attributes['config'] = json_decode($this->attributes['config'], true);
} elseif (is_array($this->attributes['config'])) {
return $this->attributes['config'];
}
}
}
/**
* PMQL value alias for fulltext field
*
* @param string $value
*
* @return callable
*/
public function valueAliasFullText($value, $expression)
{
return function ($query) use ($value) {
$this->scopeFilter($query, $value);
};
}
/**
* Filter settings with a string
*
* @param $query
*
* @param $filter string
*/
public function scopeFilter($query, $filter)
{
$filter = '%' . mb_strtolower($filter) . '%';
$query->where(function ($query) use ($filter) {
$query->where(DB::raw('LOWER(`key`)'), 'like', $filter)
->orWhere(DB::raw('LOWER(`name`)'), 'like', $filter)
->orWhere(DB::raw('LOWER(`helper`)'), 'like', $filter)
->orWhere(DB::raw('LOWER(`group`)'), 'like', $filter);
});
return $query;
}
/**
* Filter settings groups with a string
*
* @param $query
*
* @param $filter string
*/
public function notHiddenGroups($query, $filter)
{
$filter = '%' . mb_strtolower($filter) . '%';
$query->where(function ($query) use ($filter) {
$query->where(DB::raw('LOWER(`group`)'), 'like', $filter);
});
return $query;
}
/**
* @return bool
* @throws \Exception
*/
public static function loginIsDefault()
{
return stripos(self::getLogin(), 'processmaker-login') !== false;
}
/**
* @return string
* @throws \Exception
*/
public static function getLogin()
{
// default login
$url = asset(config('app.settings.login_logo_path'));
//custom login
$setting = self::byKey('css-override');
if ($setting) {
$mediaFile = $setting->getMedia(self::COLLECTION_CSS_LOGIN);
foreach ($mediaFile as $media) {
$url = $media->getFullUrl();
}
}
return $url . '?id=' . bin2hex(random_bytes(16));
}
/**
* @return string
* @throws \Exception
*/
public static function getLogo()
{
// default logo
$url = asset(config('app.settings.main_logo_path'));
// custom logo
if (config()->has($key = 'css-override')) {
$setting = self::byKey($key);
if ($setting instanceof self) {
$mediaFile = $setting->getMedia(self::COLLECTION_CSS_LOGO);
foreach ($mediaFile as $media) {
$url = $media->getFullUrl();
}
}
}
return $url;
}
/**
* @return string
* @throws \Exception
*/
public static function getIcon()
{
// default icon
$url = asset(config('app.settings.icon_path'));
// custom icon
if (config()->has($key = 'css-override')) {
$setting = self::byKey($key);
if ($setting instanceof self) {
$mediaFile = $setting->getMedia(self::COLLECTION_CSS_ICON);
foreach ($mediaFile as $media) {
$url = $media->getFullUrl();
}
}
}
return $url . '?id=' . bin2hex(random_bytes(16));
}
/**
* @return string
* @throws \Exception
*/
public static function getFavicon()
{
// default icon
$url = asset(config('app.settings.favicon_path'));
// custom icon
if (config()->has($key = 'css-override')) {
$setting = self::byKey($key);
if ($setting instanceof self) {
$mediaFile = $setting->getMedia(self::COLLECTION_CSS_FAVICON);
foreach ($mediaFile as $media) {
$url = $media->getFullUrl();
}
}
}
return $url . '?id=' . bin2hex(random_bytes(16));
}
}