forked from ProcessMaker/processmaker
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathScreen.php
More file actions
230 lines (206 loc) · 5.54 KB
/
Screen.php
File metadata and controls
230 lines (206 loc) · 5.54 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
<?php
namespace ProcessMaker\Models;
use Carbon\Carbon;
use Illuminate\Validation\Rule;
use ProcessMaker\Assets\ScreensInScreen;
use ProcessMaker\Contracts\ScreenInterface;
use ProcessMaker\Traits\Exportable;
use ProcessMaker\Traits\ExtendedPMQL;
use ProcessMaker\Traits\HasCategories;
use ProcessMaker\Traits\HasScreenFields;
use ProcessMaker\Traits\HasVersioning;
use ProcessMaker\Traits\HideSystemResources;
use ProcessMaker\Traits\SerializeToIso8601;
use ProcessMaker\Validation\CategoryRule;
/**
* Class Screen
*
*
* @property string id
* @property string title
* @property string description
* @property array content
* @property array config
* @property array computed
* @property array custom_css
* @property array watchers
* @property string label
* @property Carbon type
* @property Carbon $updated_at
* @property Carbon $created_at
*
* @OA\Schema(
* schema="screensEditable",
* @OA\Property(property="title", type="string"),
* @OA\Property(property="type", type="string"),
* @OA\Property(property="description", type="string"),
* @OA\Property(property="config", type="array", @OA\Items(type="object")),
* @OA\Property(property="computed", type="array", @OA\Items(type="object")),
* @OA\Property(property="watchers", type="array", @OA\Items(type="object")),
* @OA\Property(property="custom_css", type="string"),
* @OA\Property(property="screen_category_id", type="string"),
* ),
* @OA\Schema(
* schema="screens",
* allOf={
* @OA\Schema(ref="#/components/schemas/screensEditable"),
* @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"),
* ),
* },
* )
*
* @OA\Schema(
* schema="screenExported",
* @OA\Property(property="url", type="string"),
* )
*/
class Screen extends ProcessMakerModel implements ScreenInterface
{
use SerializeToIso8601;
use HideSystemResources;
use HasCategories;
use HasScreenFields;
use HasVersioning;
use ExtendedPMQL;
use Exportable;
const categoryClass = ScreenCategory::class;
protected $connection = 'processmaker';
/**
* The table name attribute
* @var string
*/
protected $table = 'screens';
protected $casts = [
'config' => 'array',
'computed' => 'array',
'watchers' => 'array',
];
/**
* The attributes that aren't mass assignable.
*
* @var array
*/
protected $guarded = [
'id',
'created_at',
'updated_at',
];
/**
* Table columns.
*
* @var array
*/
protected $columns = [
'id',
'screen_category_id',
'title',
'description',
'type',
'config',
'computed',
'custom_css',
'created_at',
'updated_at',
'status',
'key',
'watchers',
];
/**
* Validation rules
*
* @param $existing
*
* @return array
*/
public static function rules($existing = null)
{
$unique = Rule::unique('screens')->ignore($existing);
return [
'title' => ['required', $unique, 'alpha_spaces'],
'description' => 'required',
'type' => 'required',
'screen_category_id' => [new CategoryRule($existing)],
];
}
/**
* Get the associated versions
*/
public function versions()
{
return $this->hasMany(ScreenVersion::class);
}
/**
* Get the associated category
*/
public function category()
{
return $this->belongsTo(ScreenCategory::class, 'screen_category_id');
}
public function scopeExclude($query, $value = [])
{
$columns = array_diff($this->columns, (array) $value);
$columns = array_map(function ($column) {
return $this->table . '.' . $column;
}, $columns);
return $query->select($columns);
}
/**
* Set multiple|single categories to the screen
*
* @param string $value
*/
public function setScreenCategoryIdAttribute($value)
{
return $this->setMultipleCategories($value, 'screen_category_id');
}
/**
* Get multiple|single categories of the screen
*
* @param string $value
*/
public function getScreenCategoryIdAttribute($value)
{
return implode(',', $this->categories()->pluck('category_id')->toArray()) ?: $value;
}
public function builderComponent()
{
if (isset($this->config['builderComponent'])) {
return $this->config['builderComponent'];
}
return 'ScreenBuilder';
}
public function renderComponent()
{
if (isset($this->config['renderComponent'])) {
return $this->config['renderComponent'];
}
return 'task-screen';
}
/**
* PMQL field (id = screens.id)
*
* @return string
*/
public function fieldAliasId()
{
return 'screens.id';
}
/**
* Get a recursive list of nested screens IDs in this screen
*
* @return int[] nested screen IDs
*/
public function nestedScreenIds(ProcessRequest $processRequest = null)
{
$screenIds = [];
$screenFinder = new ScreensInScreen();
$screenFinder->setProcessRequest($processRequest);
foreach ($screenFinder->referencesToExport($this) as $screen) {
$screenIds[] = $screen[1];
}
return $screenIds;
}
}