-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcode.power
More file actions
334 lines (294 loc) · 5.7 KB
/
code.power
File metadata and controls
334 lines (294 loc) · 5.7 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
/**
* The starting row.
*
* @var int
* @since 5.1.4
*/
protected int $startingRow = 2;
/**
* The minimal column number
*
* @var int
* @since 5.1.4
*/
protected int $minimalColumns = 2;
/**
* The parent table of each row.
*
* @var string
* @since 5.1.4
*/
protected string $parentTable = '';
/**
* The parent table key field.
*
* @var string
* @since 5.1.4
*/
protected string $parentKey = '';
/**
* The parent join key field to other tables.
*
* @var string
* @since 5.1.4
*/
protected string $parentJoinKey = '';
/**
* The parent table key field used to link rows to existing data.
*
* @var string
* @since 5.1.4
*/
protected string $linkField = 'guid';
/**
* The data key used inside the import payload.
*
* @var string
* @since 5.1.4
*/
protected string $dataKey = 'import';
/**
* Join tables key field map.
* That links an item to the existing item
*
* @var array
* @since 5.1.4
*/
protected array $joinFields = [];
/* ==========================================================================
* Getters
* ========================================================================== */
/**
* Get the starting row.
*
* @return int
* @since 5.1.4
*/
public function getStartingRow(): int
{
return $this->startingRow;
}
/**
* Get the minimal columns number.
*
* @return int
* @since 5.1.4
*/
public function getMinimalColumns(): int
{
return $this->minimalColumns;
}
/**
* Get the parent table.
*
* @return string
* @since 5.1.4
*/
public function getParentTable(): string
{
return $this->parentTable;
}
/**
* Get the parent key field.
*
* @return string
* @since 5.1.4
*/
public function getParentKey(): string
{
return $this->parentKey;
}
/**
* Get the parent join key field.
*
* @return string
* @since 5.1.4
*/
public function getParentJoinKey(): string
{
return $this->parentJoinKey;
}
/**
* Get the link field.
*
* @return string
* @since 5.1.4
*/
public function getLinkField(): string
{
return $this->linkField;
}
/**
* Get the data key.
*
* @return string
* @since 5.1.4
*/
public function getDataKey(): string
{
return $this->dataKey;
}
/**
* Get the join tables key fields map.
*
* Defines how related tables link back to the parent entity
* during the import process.
*
* @return array
* @since 5.1.4
*/
public function getJoinFields(): array
{
return $this->joinFields;
}
/* ==========================================================================
* Setters
* ========================================================================== */
/**
* Set the starting row.
*
* @param int $row
*
* @return self
* @since 5.1.4
*
* @throws \InvalidArgumentException
*/
public function setStartingRow(int $row): self
{
if ($row < 1)
{
throw new \InvalidArgumentException('Starting row must be >= 1.');
}
$this->startingRow = $row;
return $this;
}
/**
* Set the minimal columns number.
*
* @param int $number The minimal columns number (must be >= 1).
*
* @return self
* @since 5.1.4
*/
public function setMinimalColumns(int $number): self
{
if ($number < 1)
{
throw new \InvalidArgumentException('Minimal columns must be >= 1.');
}
$this->minimalColumns = $number;
return $this;
}
/**
* Set the parent table.
*
* @param string $table
*
* @return self
* @since 5.1.4
*
* @throws \InvalidArgumentException
*/
public function setParentTable(string $table): self
{
if ($table === '')
{
throw new \InvalidArgumentException('Parent table cannot be empty.');
}
$this->parentTable = $table;
return $this;
}
/**
* Set the parent key field.
*
* @param string $key
*
* @return self
* @since 5.1.4
*
* @throws \InvalidArgumentException
*/
public function setParentKey(string $key): self
{
if ($key === '')
{
throw new \InvalidArgumentException('Parent key cannot be empty.');
}
$this->parentKey = $key;
return $this;
}
/**
* Set the parent join key field.
*
* @param string $key
*
* @return self
* @since 5.1.4
*
* @throws \InvalidArgumentException
*/
public function setParentJoinKey(string $key): self
{
if ($key === '')
{
throw new \InvalidArgumentException('Parent join key cannot be empty.');
}
$this->parentJoinKey = $key;
return $this;
}
/**
* Set the link field.
*
* @param string $field
*
* @return self
* @since 5.1.4
*
* @throws \InvalidArgumentException
*/
public function setLinkField(string $field): self
{
if ($field === '')
{
throw new \InvalidArgumentException('Link field cannot be empty.');
}
$this->linkField = $field;
return $this;
}
/**
* Set the data key.
*
* @param string $key
*
* @return self
* @since 5.1.4
*
* @throws \InvalidArgumentException
*/
public function setDataKey(string $key): self
{
if ($key === '')
{
throw new \InvalidArgumentException('Data key cannot be empty.');
}
$this->dataKey = $key;
return $this;
}
/**
* Set the key join fields map.
*
* @param array $map
*
* Example: [
* 'table' => ['link_fields' => ['field']]
* ]
*
* @return self
* @since 5.1.4
*/
public function setJoinFields(array $map): self
{
$this->joinFields = $map;
return $this;
}