1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace NotificationChannels\Apn; |
4
|
|
|
|
5
|
|
|
use DateTime; |
6
|
|
|
use Pushok\Client; |
7
|
|
|
|
8
|
|
|
class ApnMessage |
9
|
|
|
{ |
10
|
|
|
/** |
11
|
|
|
* The title of the notification. |
12
|
|
|
* |
13
|
|
|
* @var string |
14
|
|
|
*/ |
15
|
|
|
public $title; |
16
|
|
|
|
17
|
|
|
/** |
18
|
|
|
* The body of the notification. |
19
|
|
|
* |
20
|
|
|
* @var string |
21
|
|
|
*/ |
22
|
|
|
public $body; |
23
|
|
|
|
24
|
|
|
/** |
25
|
|
|
* The badge of the notification. |
26
|
|
|
* |
27
|
|
|
* @var int |
28
|
|
|
*/ |
29
|
|
|
public $badge; |
30
|
|
|
|
31
|
|
|
/** |
32
|
|
|
* The sound for the notification. |
33
|
|
|
* |
34
|
|
|
* @var string|null |
35
|
|
|
*/ |
36
|
|
|
public $sound; |
37
|
|
|
|
38
|
|
|
/** |
39
|
|
|
* The category for action button. |
40
|
|
|
* |
41
|
|
|
* @var string|null |
42
|
|
|
* */ |
43
|
|
|
public $category; |
44
|
|
|
|
45
|
|
|
/** |
46
|
|
|
* Value indicating incoming resource in the notification. |
47
|
|
|
* |
48
|
|
|
* @var int|null |
49
|
|
|
*/ |
50
|
|
|
public $contentAvailable = null; |
51
|
|
|
|
52
|
|
|
/** |
53
|
|
|
* The key to a title string in the Localizable.strings file for the current localization. |
54
|
|
|
* |
55
|
|
|
* @var string|null |
56
|
|
|
*/ |
57
|
|
|
public $titleLocKey; |
58
|
|
|
|
59
|
|
|
/** |
60
|
|
|
* Variable string values to appear in place of the format specifiers in title-loc-key. |
61
|
|
|
* |
62
|
|
|
* @var string|null |
63
|
|
|
*/ |
64
|
|
|
public $titleLocArgs; |
65
|
|
|
|
66
|
|
|
/** |
67
|
|
|
* If a string is specified, the iOS system displays an alert that includes the Close and View buttons. |
68
|
|
|
* |
69
|
|
|
* @var string|null |
70
|
|
|
*/ |
71
|
|
|
public $actionLocKey; |
72
|
|
|
|
73
|
|
|
/** |
74
|
|
|
* A key to an alert-message string in a Localizable.strings file for the current localization. |
75
|
|
|
* |
76
|
|
|
* @var string|null |
77
|
|
|
*/ |
78
|
|
|
public $locKey; |
79
|
|
|
|
80
|
|
|
/** |
81
|
|
|
* Variable string values to appear in place of the format specifiers in loc-key. |
82
|
|
|
* |
83
|
|
|
* @var array|null |
84
|
|
|
*/ |
85
|
|
|
public $locArgs; |
86
|
|
|
|
87
|
|
|
/** |
88
|
|
|
* Additional data of the notification. |
89
|
|
|
* |
90
|
|
|
* @var array |
91
|
|
|
*/ |
92
|
|
|
public $custom = []; |
93
|
|
|
|
94
|
|
|
/** |
95
|
|
|
* Value indicating when the message will expire. |
96
|
|
|
* |
97
|
|
|
* @var \string |
98
|
|
|
*/ |
99
|
|
|
public $pushType = null; |
100
|
|
|
|
101
|
|
|
/** |
102
|
|
|
* The expiration time of the notification. |
103
|
|
|
* |
104
|
|
|
* @var \DateTime|null |
105
|
|
|
*/ |
106
|
|
|
public $expiresAt = null; |
107
|
|
|
|
108
|
|
|
/** |
109
|
|
|
* Message specific client. |
110
|
|
|
* |
111
|
|
|
* @var \Pushok\Client|null |
112
|
|
|
*/ |
113
|
|
|
public $client = null; |
114
|
|
|
|
115
|
|
|
/** |
116
|
|
|
* The notification service app extension flag. |
117
|
|
|
* |
118
|
|
|
* @var int|null |
119
|
|
|
*/ |
120
|
|
|
public $mutableContent = null; |
121
|
|
|
|
122
|
|
|
/** |
123
|
|
|
* @param string|null $title |
124
|
|
|
* @param string|null $body |
125
|
|
|
* @param array $custom |
126
|
|
|
* @param null|int $badge |
127
|
|
|
* |
128
|
|
|
* @return static |
129
|
|
|
*/ |
130
|
1 |
|
public static function create($title = null, $body = null, $custom = [], $badge = null) |
131
|
|
|
{ |
132
|
1 |
|
return new static($title, $body, $custom, $badge); |
133
|
|
|
} |
134
|
|
|
|
135
|
|
|
/** |
136
|
|
|
* @param string|null $title |
137
|
|
|
* @param string|null $body |
138
|
|
|
* @param array $custom |
139
|
|
|
* @param null|int $badge |
140
|
|
|
*/ |
141
|
37 |
|
public function __construct($title = null, $body = null, $custom = [], $badge = null) |
142
|
|
|
{ |
143
|
37 |
|
$this->title = $title; |
144
|
37 |
|
$this->body = $body; |
145
|
37 |
|
$this->custom = $custom; |
146
|
37 |
|
$this->badge = $badge; |
147
|
37 |
|
} |
148
|
|
|
|
149
|
|
|
/** |
150
|
|
|
* Set the alert title of the notification. |
151
|
|
|
* |
152
|
|
|
* @param string $title |
153
|
|
|
* |
154
|
|
|
* @return $this |
155
|
|
|
*/ |
156
|
2 |
|
public function title($title) |
157
|
|
|
{ |
158
|
2 |
|
$this->title = $title; |
159
|
|
|
|
160
|
2 |
|
return $this; |
161
|
|
|
} |
162
|
|
|
|
163
|
|
|
/** |
164
|
|
|
* Set the alert message of the notification. |
165
|
|
|
* |
166
|
|
|
* @param string $body |
167
|
|
|
* |
168
|
|
|
* @return $this |
169
|
|
|
*/ |
170
|
2 |
|
public function body($body) |
171
|
|
|
{ |
172
|
2 |
|
$this->body = $body; |
173
|
|
|
|
174
|
2 |
|
return $this; |
175
|
|
|
} |
176
|
|
|
|
177
|
|
|
/** |
178
|
|
|
* Set the badge of the notification. |
179
|
|
|
* |
180
|
|
|
* @param int $badge |
181
|
|
|
* |
182
|
|
|
* @return $this |
183
|
|
|
*/ |
184
|
2 |
|
public function badge($badge) |
185
|
|
|
{ |
186
|
2 |
|
$this->badge = $badge; |
187
|
|
|
|
188
|
2 |
|
return $this; |
189
|
|
|
} |
190
|
|
|
|
191
|
|
|
/** |
192
|
|
|
* Set the sound for the notification. |
193
|
|
|
* |
194
|
|
|
* @param string|null $sound |
195
|
|
|
* |
196
|
|
|
* @return $this |
197
|
|
|
*/ |
198
|
3 |
|
public function sound($sound = 'default') |
199
|
|
|
{ |
200
|
3 |
|
$this->sound = $sound; |
201
|
|
|
|
202
|
3 |
|
return $this; |
203
|
|
|
} |
204
|
|
|
|
205
|
|
|
/** |
206
|
|
|
* Set category for this notification. |
207
|
|
|
* |
208
|
|
|
* @param string|null $category |
209
|
|
|
* |
210
|
|
|
* @return $this |
211
|
|
|
* */ |
212
|
2 |
|
public function category($category) |
213
|
|
|
{ |
214
|
2 |
|
$this->category = $category; |
215
|
|
|
|
216
|
2 |
|
return $this; |
217
|
|
|
} |
218
|
|
|
|
219
|
|
|
/** |
220
|
|
|
* Set content available value for this notification. |
221
|
|
|
* |
222
|
|
|
* @param int $value |
223
|
|
|
* |
224
|
|
|
* @return $this |
225
|
|
|
*/ |
226
|
2 |
|
public function contentAvailable($value = 1) |
227
|
|
|
{ |
228
|
2 |
|
$this->contentAvailable = $value; |
229
|
|
|
|
230
|
2 |
|
return $this; |
231
|
|
|
} |
232
|
|
|
|
233
|
|
|
/** |
234
|
|
|
* Set the push type for this notification. |
235
|
|
|
* |
236
|
|
|
* @param string $pushType |
237
|
|
|
* |
238
|
|
|
* @return $this |
239
|
|
|
*/ |
240
|
5 |
|
public function pushType(string $pushType) |
241
|
|
|
{ |
242
|
5 |
|
$this->pushType = $pushType; |
|
|
|
|
243
|
|
|
|
244
|
5 |
|
return $this; |
245
|
|
|
} |
246
|
|
|
|
247
|
|
|
/** |
248
|
|
|
* Set the expiration time for the message. |
249
|
|
|
* |
250
|
|
|
* @param \DateTime $expiresAt |
251
|
|
|
* |
252
|
|
|
* @return $this |
253
|
|
|
*/ |
254
|
2 |
|
public function expiresAt(DateTime $expiresAt) |
255
|
|
|
{ |
256
|
2 |
|
$this->expiresAt = $expiresAt; |
257
|
|
|
|
258
|
2 |
|
return $this; |
259
|
|
|
} |
260
|
|
|
|
261
|
|
|
/** |
262
|
|
|
* Set a title-loc-key. |
263
|
|
|
* |
264
|
|
|
* @param string|null $titleLocKey |
265
|
|
|
* @return $this |
266
|
|
|
*/ |
267
|
1 |
|
public function titleLocKey($titleLocKey = null) |
268
|
|
|
{ |
269
|
1 |
|
$this->titleLocKey = $titleLocKey; |
270
|
|
|
|
271
|
1 |
|
return $this; |
272
|
|
|
} |
273
|
|
|
|
274
|
|
|
/** |
275
|
|
|
* Set the title-loc-args. |
276
|
|
|
* |
277
|
|
|
* @param array|null $titleLocArgs |
278
|
|
|
* @return $this |
279
|
|
|
*/ |
280
|
1 |
|
public function titleLocArgs(array $titleLocArgs = null) |
281
|
|
|
{ |
282
|
1 |
|
$this->titleLocArgs = $titleLocArgs; |
|
|
|
|
283
|
|
|
|
284
|
1 |
|
return $this; |
285
|
|
|
} |
286
|
|
|
|
287
|
|
|
/** |
288
|
|
|
* Set an action-loc-key. |
289
|
|
|
* |
290
|
|
|
* @param string|null $actionLocKey |
291
|
|
|
* @return $this |
292
|
|
|
*/ |
293
|
1 |
|
public function actionLocKey($actionLocKey = null) |
294
|
|
|
{ |
295
|
1 |
|
$this->actionLocKey = $actionLocKey; |
296
|
|
|
|
297
|
1 |
|
return $this; |
298
|
|
|
} |
299
|
|
|
|
300
|
|
|
/** |
301
|
|
|
* Set a loc-key. |
302
|
|
|
* |
303
|
|
|
* @param string $locKey |
304
|
|
|
* @return $this |
305
|
|
|
*/ |
306
|
1 |
|
public function setLocKey($locKey) |
307
|
|
|
{ |
308
|
1 |
|
$this->locKey = $locKey; |
309
|
|
|
|
310
|
1 |
|
return $this; |
311
|
|
|
} |
312
|
|
|
|
313
|
|
|
/** |
314
|
|
|
* Set the loc-args. |
315
|
|
|
* |
316
|
|
|
* @param array $locArgs |
317
|
|
|
* @return $this |
318
|
|
|
*/ |
319
|
1 |
|
public function setLocArgs($locArgs) |
320
|
|
|
{ |
321
|
1 |
|
$this->locArgs = $locArgs; |
322
|
|
|
|
323
|
1 |
|
return $this; |
324
|
|
|
} |
325
|
|
|
|
326
|
|
|
/** |
327
|
|
|
* Add custom data to the notification. |
328
|
|
|
* |
329
|
|
|
* @param string $key |
330
|
|
|
* @param mixed $value |
331
|
|
|
* |
332
|
|
|
* @return $this |
333
|
|
|
*/ |
334
|
3 |
|
public function custom($key, $value) |
335
|
|
|
{ |
336
|
3 |
|
$this->custom[$key] = $value; |
337
|
|
|
|
338
|
3 |
|
return $this; |
339
|
|
|
} |
340
|
|
|
|
341
|
|
|
/** |
342
|
|
|
* Override the data of the notification. |
343
|
|
|
* |
344
|
|
|
* @param array $custom |
345
|
|
|
* |
346
|
|
|
* @return $this |
347
|
|
|
*/ |
348
|
1 |
|
public function setCustom($custom) |
349
|
|
|
{ |
350
|
1 |
|
$this->custom = $custom; |
351
|
|
|
|
352
|
1 |
|
return $this; |
353
|
|
|
} |
354
|
|
|
|
355
|
|
|
/** |
356
|
|
|
* Add an action to the notification. |
357
|
|
|
* |
358
|
|
|
* @param string $action |
359
|
|
|
* @param mixed $params |
360
|
|
|
* |
361
|
|
|
* @return $this |
362
|
|
|
*/ |
363
|
1 |
|
public function action($action, $params = null) |
364
|
|
|
{ |
365
|
1 |
|
return $this->custom('action', [ |
366
|
1 |
|
'action' => $action, |
367
|
1 |
|
'params' => $params, |
368
|
|
|
]); |
369
|
|
|
} |
370
|
|
|
|
371
|
|
|
/** |
372
|
|
|
* Set message specific client. |
373
|
|
|
* |
374
|
|
|
* @param \Pushok\Client |
375
|
|
|
* @return $this |
376
|
|
|
*/ |
377
|
3 |
|
public function via(Client $client) |
378
|
|
|
{ |
379
|
3 |
|
$this->client = $client; |
380
|
|
|
|
381
|
3 |
|
return $this; |
382
|
|
|
} |
383
|
|
|
|
384
|
|
|
/** |
385
|
|
|
* Set mutable content value for this notification. |
386
|
|
|
* |
387
|
|
|
* @param int $value |
388
|
|
|
* |
389
|
|
|
* @return $this |
390
|
|
|
*/ |
391
|
2 |
|
public function mutableContent($value = 1) |
392
|
|
|
{ |
393
|
2 |
|
$this->mutableContent = $value; |
394
|
|
|
|
395
|
2 |
|
return $this; |
396
|
|
|
} |
397
|
|
|
} |
398
|
|
|
|
Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.
Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..