AccountResourceModel::setFirstDayOfWeek()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 6

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 3
CRAP Score 1

Importance

Changes 0
Metric Value
dl 0
loc 6
ccs 3
cts 3
cp 1
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 1
crap 1
1
<?php
2
3
/*
4
 * This file is part of the zibios/wrike-php-jmsserializer package.
5
 *
6
 * (c) Zbigniew Ślązak
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
namespace Zibios\WrikePhpJmsserializer\Model\Account;
13
14
use JMS\Serializer\Annotation as SA;
15
use Zibios\WrikePhpJmsserializer\Model\AbstractModel;
16
use Zibios\WrikePhpJmsserializer\Model\Common\MetadataModel;
17
use Zibios\WrikePhpJmsserializer\Model\Common\SubscriptionModel;
18
use Zibios\WrikePhpJmsserializer\Model\CustomField\CustomFieldResourceModel;
19
use Zibios\WrikePhpJmsserializer\Model\ResourceModelInterface;
20
21
/**
22
 * Account Resource Model.
23
 */
24
class AccountResourceModel extends AbstractModel implements ResourceModelInterface
25
{
26
    /**
27
     * Account ID.
28
     *
29
     * Comment: Account ID
30
     *
31
     * @SA\Type("string")
32
     * @SA\SerializedName("id")
33
     *
34
     * @var string|null
35
     */
36
    protected $id;
37
38
    /**
39
     * Name of account.
40
     *
41
     * @SA\Type("string")
42
     * @SA\SerializedName("name")
43
     *
44
     * @var string|null
45
     */
46
    protected $name;
47
48
    /**
49
     * Date format: dd/MM/yyyy or MM/dd/yyyy.
50
     *
51
     * @SA\Type("string")
52
     * @SA\SerializedName("dateFormat")
53
     *
54
     * @var string|null
55
     */
56
    protected $dateFormat;
57
58
    /**
59
     * First day of week.
60
     *
61
     * Week Day, Enum: Sat, Sun, Mon
62
     *
63
     * @see \Zibios\WrikePhpLibrary\Enum\WeekDayEnum
64
     *
65
     * @SA\Type("string")
66
     * @SA\SerializedName("firstDayOfWeek")
67
     *
68
     * @var string|null
69
     */
70
    protected $firstDayOfWeek;
71
72
    /**
73
     * List of weekdays, not empty.
74
     *
75
     * These days are used in task duration computation.
76
     * Week Day, Enum: Sun, Mon, Tue, Wed, Thu, Fri, Sat
77
     *
78
     * @see \Zibios\WrikePhpLibrary\Enum\WeekDayEnum
79
     *
80
     * @SA\Type("array<string>")
81
     * @SA\SerializedName("workDays")
82
     *
83
     * @var array|string[]|null
84
     */
85
    protected $workDays;
86
87
    /**
88
     * Virtual folder, denotes the root folder of the account.
89
     *
90
     * Different users can have different elements in the root, according to their sharing scope.
91
     * Can be used in queries to get all folders/tasks in the account,
92
     * or to create folders/tasks in the user's account root
93
     *
94
     * Comment: Folder ID
95
     *
96
     * @SA\Type("string")
97
     * @SA\SerializedName("rootFolderId")
98
     *
99
     * @var string|null
100
     */
101
    protected $rootFolderId;
102
103
    /**
104
     * Virtual folder, denotes the root for deleted folders and tasks.
105
     *
106
     * Can be used in queries to get all folders/tasks in the Recycle Bin. Cannot be used in modification queries.
107
     *
108
     * Comment: Folder ID
109
     *
110
     * @SA\Type("string")
111
     * @SA\SerializedName("recycleBinId")
112
     *
113
     * @var string|null
114
     */
115
    protected $recycleBinId;
116
117
    /**
118
     * Registration date.
119
     *
120
     * Format: yyyy-MM-dd'T'HH:mm:ss'Z'
121
     *
122
     * @SA\Type("string")
123
     * @SA\SerializedName("createdDate")
124
     *
125
     * @var string|null
126
     */
127
    protected $createdDate;
128
129
    /**
130
     * Account subscription.
131
     *
132
     * Comment: Optional
133
     *
134
     * @SA\Type("Zibios\WrikePhpJmsserializer\Model\Common\SubscriptionModel")
135
     * @SA\SerializedName("subscription")
136
     *
137
     * @var SubscriptionModel|null
138
     */
139
    protected $subscription;
140
141
    /**
142
     * List of account metadata entries.
143
     * Entries could be read by all users of account and modified by admins only
144
     * Metadata entry key-value pair
145
     * Metadata entries are isolated on per-client (application) basis.
146
     *
147
     * Comment: Optional
148
     *
149
     * @SA\Type("array<Zibios\WrikePhpJmsserializer\Model\Common\MetadataModel>")
150
     * @SA\SerializedName("metadata")
151
     *
152
     * @var array|MetadataModel[]|null
153
     */
154
    protected $metadata;
155
156
    /**
157
     * List of custom fields accessible for requesting user in the account.
158
     * Entries could be read by all users of account and modified by admins only.
159
     *
160
     * Comment: Optional
161
     *
162
     * @SA\Type("array<Zibios\WrikePhpJmsserializer\Model\CustomField\CustomFieldResourceModel>")
163
     * @SA\SerializedName("customFields")
164
     *
165
     * @var array|CustomFieldResourceModel[]|null
166
     */
167
    protected $customFields;
168
169
    /**
170
     * Date when the user has joined the account.
171
     *
172
     * Format: yyyy-MM-dd'T'HH:mm:ss'Z'
173
     *
174
     * @SA\Type("string")
175
     * @SA\SerializedName("joinedDate")
176
     *
177
     * @var string|null
178
     */
179
    protected $joinedDate;
180
181
    /**
182
     * @return null|string
183
     */
184 1
    public function getId()
185
    {
186 1
        return $this->id;
187
    }
188
189
    /**
190
     * @param null|string $id
191
     *
192
     * @return $this
193
     */
194 1
    public function setId($id)
195
    {
196 1
        $this->id = $id;
197
198 1
        return $this;
199
    }
200
201
    /**
202
     * @return null|string
203
     */
204 1
    public function getName()
205
    {
206 1
        return $this->name;
207
    }
208
209
    /**
210
     * @param null|string $name
211
     *
212
     * @return $this
213
     */
214 1
    public function setName($name)
215
    {
216 1
        $this->name = $name;
217
218 1
        return $this;
219
    }
220
221
    /**
222
     * @return null|string
223
     */
224 1
    public function getDateFormat()
225
    {
226 1
        return $this->dateFormat;
227
    }
228
229
    /**
230
     * @param null|string $dateFormat
231
     *
232
     * @return $this
233
     */
234 1
    public function setDateFormat($dateFormat)
235
    {
236 1
        $this->dateFormat = $dateFormat;
237
238 1
        return $this;
239
    }
240
241
    /**
242
     * @return null|string
243
     */
244 1
    public function getFirstDayOfWeek()
245
    {
246 1
        return $this->firstDayOfWeek;
247
    }
248
249
    /**
250
     * @param null|string $firstDayOfWeek
251
     *
252
     * @return $this
253
     */
254 1
    public function setFirstDayOfWeek($firstDayOfWeek)
255
    {
256 1
        $this->firstDayOfWeek = $firstDayOfWeek;
257
258 1
        return $this;
259
    }
260
261
    /**
262
     * @return null|array|string[]
263
     */
264 1
    public function getWorkDays()
265
    {
266 1
        return $this->workDays;
267
    }
268
269
    /**
270
     * @param null|array|string[] $workDays
271
     *
272
     * @return $this
273
     */
274 1
    public function setWorkDays($workDays)
275
    {
276 1
        $this->workDays = $workDays;
277
278 1
        return $this;
279
    }
280
281
    /**
282
     * @return null|string
283
     */
284 1
    public function getRootFolderId()
285
    {
286 1
        return $this->rootFolderId;
287
    }
288
289
    /**
290
     * @param null|string $rootFolderId
291
     *
292
     * @return $this
293
     */
294 1
    public function setRootFolderId($rootFolderId)
295
    {
296 1
        $this->rootFolderId = $rootFolderId;
297
298 1
        return $this;
299
    }
300
301
    /**
302
     * @return null|string
303
     */
304 1
    public function getRecycleBinId()
305
    {
306 1
        return $this->recycleBinId;
307
    }
308
309
    /**
310
     * @param null|string $recycleBinId
311
     *
312
     * @return $this
313
     */
314 1
    public function setRecycleBinId($recycleBinId)
315
    {
316 1
        $this->recycleBinId = $recycleBinId;
317
318 1
        return $this;
319
    }
320
321
    /**
322
     * @return string|null
323
     */
324 1
    public function getCreatedDate()
325
    {
326 1
        return $this->createdDate;
327
    }
328
329
    /**
330
     * @param string|null $createdDate
331
     *
332
     * @return $this
333
     */
334 1
    public function setCreatedDate($createdDate)
335
    {
336 1
        $this->createdDate = $createdDate;
337
338 1
        return $this;
339
    }
340
341
    /**
342
     * @return null|SubscriptionModel
343
     */
344 1
    public function getSubscription()
345
    {
346 1
        return $this->subscription;
347
    }
348
349
    /**
350
     * @param null|SubscriptionModel $subscription
351
     *
352
     * @return $this
353
     */
354 1
    public function setSubscription($subscription)
355
    {
356 1
        $this->subscription = $subscription;
357
358 1
        return $this;
359
    }
360
361
    /**
362
     * @return array|null|MetadataModel[]
363
     */
364 1
    public function getMetadata()
365
    {
366 1
        return $this->metadata;
367
    }
368
369
    /**
370
     * @param array|null|MetadataModel[] $metadata
371
     *
372
     * @return $this
373
     */
374 1
    public function setMetadata($metadata)
375
    {
376 1
        $this->metadata = $metadata;
377
378 1
        return $this;
379
    }
380
381
    /**
382
     * @return array|null|CustomFieldResourceModel[]
383
     */
384 1
    public function getCustomFields()
385
    {
386 1
        return $this->customFields;
387
    }
388
389
    /**
390
     * @param array|null|CustomFieldResourceModel[] $customFields
391
     *
392
     * @return $this
393
     */
394 1
    public function setCustomFields($customFields)
395
    {
396 1
        $this->customFields = $customFields;
397
398 1
        return $this;
399
    }
400
401
    /**
402
     * @return string|null
403
     */
404 1
    public function getJoinedDate()
405
    {
406 1
        return $this->joinedDate;
407
    }
408
409
    /**
410
     * @param string|null $joinedDate
411
     *
412
     * @return $this
413
     */
414 1
    public function setJoinedDate($joinedDate)
415
    {
416 1
        $this->joinedDate = $joinedDate;
417
418 1
        return $this;
419
    }
420
}
421