|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace Soheilrt\AdobeConnectClient\Client\Entities; |
|
4
|
|
|
|
|
5
|
|
|
use DateTimeImmutable; |
|
6
|
|
|
use DateTimeInterface; |
|
7
|
|
|
use Exception; |
|
8
|
|
|
use Soheilrt\AdobeConnectClient\Client\Contracts\ArrayableInterface; |
|
9
|
|
|
use Soheilrt\AdobeConnectClient\Client\Helpers\ValueTransform as VT; |
|
10
|
|
|
use Soheilrt\AdobeConnectClient\Client\Traits\Arrayable; |
|
11
|
|
|
use Soheilrt\AdobeConnectClient\Client\Traits\Fillable; |
|
12
|
|
|
use Soheilrt\AdobeConnectClient\Client\Traits\PropertyCaller; |
|
13
|
|
|
|
|
14
|
|
|
/** |
|
15
|
|
|
* Adobe Connect SCO. |
|
16
|
|
|
* |
|
17
|
|
|
* See {@link https://helpx.adobe.com/adobe-connect/webservices/common-xml-elements-attributes.html#type} |
|
18
|
|
|
* |
|
19
|
|
|
* @property bool|string|mixed $disabled |
|
20
|
|
|
* @property bool|string|mixed $meetingPodsLayoutsLocked |
|
21
|
|
|
* @property bool|string|mixed $updateLinkedItem |
|
22
|
|
|
* @property string|mixed $icon |
|
23
|
|
|
* @property string|mixed $lang |
|
24
|
|
|
* @property string|mixed $type |
|
25
|
|
|
* @property string|mixed $version |
|
26
|
|
|
* @property string|mixed $description |
|
27
|
|
|
* @property string|mixed $name |
|
28
|
|
|
* @property string|mixed $url_path |
|
29
|
|
|
* @property DateTimeImmutable|string|mixed $date_created |
|
30
|
|
|
* @property DateTimeImmutable|string|mixed $date_modified |
|
31
|
|
|
* @property DateTimeImmutable|string|mixed $date_begin |
|
32
|
|
|
* @property DateTimeImmutable|string|mixed $date_end |
|
33
|
|
|
* @property int|string|mixed $max_retires |
|
34
|
|
|
* @property int|string|mixed $sco_id |
|
35
|
|
|
* @property int|string|mixed $source_sco_id |
|
36
|
|
|
* @property int|string|mixed $display_seq |
|
37
|
|
|
* @property int|string|mixed $folder_id |
|
38
|
|
|
* @property int|string|mixed $accountId |
|
39
|
|
|
* |
|
40
|
|
|
* |
|
41
|
|
|
* @method bool|string|mixed getDisabled() |
|
42
|
|
|
* @method bool|string|mixed getMeetingPodsLayoutsLocked() |
|
43
|
|
|
* @method string|mixed getIcon() |
|
44
|
|
|
* @method string|mixed getLang() |
|
45
|
|
|
* @method string|mixed getType() |
|
46
|
|
|
* @method string|mixed getVersion() |
|
47
|
|
|
* @method string|mixed getDescription() |
|
48
|
|
|
* @method string|mixed getName() |
|
49
|
|
|
* @method string|mixed getUrlPath() |
|
50
|
|
|
* @method DateTimeImmutable|string|mixed getDateCreated() |
|
51
|
|
|
* @method DateTimeImmutable|string|mixed getDateModified() |
|
52
|
|
|
* @method DateTimeImmutable|string|mixed getDateBegin() |
|
53
|
|
|
* @method DateTimeImmutable|string|mixed getDateEnd() |
|
54
|
|
|
* @method int|string|mixed getMaxRetires() |
|
55
|
|
|
* @method int|string|mixed getScoId() |
|
56
|
|
|
* @method int|string|mixed getSourceScoId() |
|
57
|
|
|
* @method int|string|mixed getDisplaySeq() |
|
58
|
|
|
* @method int|string|mixed getFolderId() |
|
59
|
|
|
* @method int|string|mixed getAccountId() |
|
60
|
|
|
* |
|
61
|
|
|
* @method SCO setIcon($value) |
|
62
|
|
|
* @method SCO setLang($value) |
|
63
|
|
|
* @method SCO setType($value) |
|
64
|
|
|
* @method SCO setVersion($value) |
|
65
|
|
|
* @method SCO setDescription($value) |
|
66
|
|
|
* @method SCO setName($value) |
|
67
|
|
|
* @method SCO setUrlPath($value) |
|
68
|
|
|
* @method SCO setMaxRetires($value) |
|
69
|
|
|
* @method SCO setScoId($value) |
|
70
|
|
|
* @method SCO setSourceScoId($value) |
|
71
|
|
|
* @method SCO setDisplaySeq($value) |
|
72
|
|
|
* @method SCO setFolderId($value) |
|
73
|
|
|
* @method SCO setAccountId($value) |
|
74
|
|
|
*/ |
|
75
|
|
|
class SCO implements ArrayableInterface |
|
76
|
|
|
{ |
|
77
|
|
|
use Arrayable, PropertyCaller,Fillable; |
|
78
|
|
|
|
|
79
|
|
|
/** |
|
80
|
|
|
* A viewable file uploaded to the server. |
|
81
|
|
|
* For example, an FLV file, an HTML file, an image, a pod, and so on. |
|
82
|
|
|
* |
|
83
|
|
|
* @var string |
|
84
|
|
|
*/ |
|
85
|
|
|
public const TYPE_CONTENT = 'content'; |
|
86
|
|
|
|
|
87
|
|
|
/** |
|
88
|
|
|
* A curriculum. |
|
89
|
|
|
* |
|
90
|
|
|
* @var string |
|
91
|
|
|
*/ |
|
92
|
|
|
public const TYPE_CURRICULUM = 'curriculum'; |
|
93
|
|
|
|
|
94
|
|
|
/** |
|
95
|
|
|
* An event. |
|
96
|
|
|
* |
|
97
|
|
|
* @var string |
|
98
|
|
|
*/ |
|
99
|
|
|
public const TYPE_EVENT = 'event'; |
|
100
|
|
|
|
|
101
|
|
|
/** |
|
102
|
|
|
* A folder on the server’s hard disk that contains content. |
|
103
|
|
|
* |
|
104
|
|
|
* @var string |
|
105
|
|
|
*/ |
|
106
|
|
|
public const TYPE_FOLDER = 'folder'; |
|
107
|
|
|
|
|
108
|
|
|
/** |
|
109
|
|
|
* A reference to another SCO. These links are used by curriculums to link to other SCOs. |
|
110
|
|
|
* When content is added to a curriculum, a link is created from the curriculum to the content. |
|
111
|
|
|
* |
|
112
|
|
|
* @var string |
|
113
|
|
|
*/ |
|
114
|
|
|
public const TYPE_LINK = 'link'; |
|
115
|
|
|
|
|
116
|
|
|
/** |
|
117
|
|
|
* An Adobe Connect meeting. |
|
118
|
|
|
* |
|
119
|
|
|
* @var string |
|
120
|
|
|
*/ |
|
121
|
|
|
public const TYPE_MEETING = 'meeting'; |
|
122
|
|
|
|
|
123
|
|
|
/** |
|
124
|
|
|
* One occurrence of a recurring Adobe Connect meeting. |
|
125
|
|
|
* |
|
126
|
|
|
* @var string |
|
127
|
|
|
*/ |
|
128
|
|
|
public const TYPE_SESSION = 'session'; |
|
129
|
|
|
|
|
130
|
|
|
/** |
|
131
|
|
|
* The root of a folder hierarchy. A tree’s root is treated as an independent hierarchy; |
|
132
|
|
|
* you can’t determine the parent folder of a tree from inside the tree. |
|
133
|
|
|
* |
|
134
|
|
|
* @var string |
|
135
|
|
|
*/ |
|
136
|
|
|
public const TYPE_TREE = 'tree'; |
|
137
|
|
|
|
|
138
|
|
|
/** |
|
139
|
|
|
* Create a new SCO Instance. |
|
140
|
|
|
* |
|
141
|
|
|
* @return SCO |
|
142
|
|
|
*/ |
|
143
|
|
|
public static function instance(): SCO |
|
144
|
|
|
{ |
|
145
|
|
|
return new static(); |
|
146
|
|
|
} |
|
147
|
|
|
|
|
148
|
|
|
/** |
|
149
|
|
|
* Set the disabled status. |
|
150
|
|
|
* |
|
151
|
|
|
* @param bool $disabled |
|
152
|
|
|
* |
|
153
|
|
|
* @return SCO |
|
154
|
|
|
*/ |
|
155
|
|
|
public function setDisabled($disabled): SCO |
|
156
|
|
|
{ |
|
157
|
|
|
$this->attributes['disabled'] = VT::toBool($disabled); |
|
158
|
|
|
|
|
159
|
|
|
return $this; |
|
160
|
|
|
} |
|
161
|
|
|
|
|
162
|
|
|
/** |
|
163
|
|
|
* Set the Created Date. |
|
164
|
|
|
* |
|
165
|
|
|
* @param DateTimeInterface|string $dateCreated |
|
166
|
|
|
* |
|
167
|
|
|
* @throws Exception |
|
168
|
|
|
* |
|
169
|
|
|
* @return SCO |
|
170
|
|
|
*/ |
|
171
|
|
|
public function setDateCreated($dateCreated): SCO |
|
172
|
|
|
{ |
|
173
|
|
|
$this->attributes['dateCreated'] = VT::toDateTimeImmutable($dateCreated); |
|
174
|
|
|
|
|
175
|
|
|
return $this; |
|
176
|
|
|
} |
|
177
|
|
|
|
|
178
|
|
|
/** |
|
179
|
|
|
* Set the Modified Date. |
|
180
|
|
|
* |
|
181
|
|
|
* @param DateTimeInterface|string $dateModified |
|
182
|
|
|
* |
|
183
|
|
|
* @throws Exception |
|
184
|
|
|
* |
|
185
|
|
|
* @return SCO |
|
186
|
|
|
*/ |
|
187
|
|
|
public function setDateModified($dateModified): SCO |
|
188
|
|
|
{ |
|
189
|
|
|
$this->attributes['dateModified'] = VT::toDateTimeImmutable($dateModified); |
|
190
|
|
|
|
|
191
|
|
|
return $this; |
|
192
|
|
|
} |
|
193
|
|
|
|
|
194
|
|
|
/** |
|
195
|
|
|
* Set the time Meeting begin. |
|
196
|
|
|
* |
|
197
|
|
|
* @param DateTimeInterface|string $dateBegin |
|
198
|
|
|
* |
|
199
|
|
|
* @throws Exception |
|
200
|
|
|
* |
|
201
|
|
|
* @return SCO |
|
202
|
|
|
*/ |
|
203
|
|
|
public function setDateBegin($dateBegin): SCO |
|
204
|
|
|
{ |
|
205
|
|
|
$this->attributes['dateBegin'] = VT::toDateTimeImmutable($dateBegin); |
|
206
|
|
|
|
|
207
|
|
|
return $this; |
|
208
|
|
|
} |
|
209
|
|
|
|
|
210
|
|
|
/** |
|
211
|
|
|
* Set the time Meeting end. |
|
212
|
|
|
* |
|
213
|
|
|
* @param DateTimeInterface|string $dateEnd |
|
214
|
|
|
* |
|
215
|
|
|
* @throws Exception |
|
216
|
|
|
* |
|
217
|
|
|
* @return SCO |
|
218
|
|
|
*/ |
|
219
|
|
|
public function setDateEnd($dateEnd): SCO |
|
220
|
|
|
{ |
|
221
|
|
|
$this->attributes['dateEnd'] = VT::toDateTimeImmutable($dateEnd); |
|
222
|
|
|
|
|
223
|
|
|
return $this; |
|
224
|
|
|
} |
|
225
|
|
|
|
|
226
|
|
|
/** |
|
227
|
|
|
* Set the Pods Layout locked status. |
|
228
|
|
|
* |
|
229
|
|
|
* @param bool $meetingPodsLayoutsLocked |
|
230
|
|
|
* |
|
231
|
|
|
* @return SCO |
|
232
|
|
|
*/ |
|
233
|
|
|
public function setMeetingPodsLayoutsLocked($meetingPodsLayoutsLocked): SCO |
|
234
|
|
|
{ |
|
235
|
|
|
$this->attributes['meetingPodsLayoutsLocked'] = VT::toBool($meetingPodsLayoutsLocked); |
|
236
|
|
|
|
|
237
|
|
|
return $this; |
|
238
|
|
|
} |
|
239
|
|
|
|
|
240
|
|
|
/** |
|
241
|
|
|
* Set the linked item status. |
|
242
|
|
|
* |
|
243
|
|
|
* @param bool $updateLinkedItem |
|
244
|
|
|
* |
|
245
|
|
|
* @return SCO |
|
246
|
|
|
*/ |
|
247
|
|
|
public function setUpdateLinkedItem($updateLinkedItem): SCO |
|
248
|
|
|
{ |
|
249
|
|
|
$this->attributes['updateLinkedItem'] = VT::toBool($updateLinkedItem); |
|
250
|
|
|
|
|
251
|
|
|
return $this; |
|
252
|
|
|
} |
|
253
|
|
|
|
|
254
|
|
|
/** |
|
255
|
|
|
* get the linked item status. |
|
256
|
|
|
* |
|
257
|
|
|
* @return bool |
|
258
|
|
|
*/ |
|
259
|
|
|
public function getUpdateLinkedItem(): bool |
|
260
|
|
|
{ |
|
261
|
|
|
return $this->attributes['updateLinkedItem'] ?? false; |
|
262
|
|
|
} |
|
263
|
|
|
} |
|
264
|
|
|
|