This repository has been archived by the owner on Jun 6, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 152
/
AppleMessage.php
300 lines (263 loc) · 6.44 KB
/
AppleMessage.php
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
<?php
namespace RMS\PushNotificationsBundle\Message;
class AppleMessage implements MessageInterface
{
/**
* Custom data for the APS body
*
* @var array
*/
protected $customData = array();
/**
* Device identifier
*
* @var null
*/
protected $identifier = null;
/**
* The APS core body
*
* @var array
*/
protected $apsBody = array();
/**
* Expiration date (UTC)
*
* A fixed UNIX epoch date expressed in seconds (UTC) that identifies when the notification is no longer valid and can be discarded.
* If the expiry value is non-zero, APNs tries to deliver the notification at least once.
* Specify zero to request that APNs not store the notification at all.
*
* @var int
*/
protected $expiry = 0;
/**
* Device push magic token
*
* @var string
*/
protected $pushMagicToken = '';
/**
* Device token
*
* @var string
*/
protected $token = '';
/**
* Whether this is a MDM message or not
*
* @var bool
*/
protected $isMdmMessage = false;
/**
* Class constructor
*/
public function __construct($identifier = NULL)
{
$this->apsBody = array(
"aps" => array(
),
);
if ($identifier !== NULL) {
$this->identifier = $identifier;
}
}
/**
* Sets the message. For iOS, this is the APS alert message
*
* @param $message
*/
public function setMessage($message)
{
$this->apsBody["aps"]["alert"] = $message;
}
/**
* Sets any custom data for the APS body
*
* @param array $data
*/
public function setData($data)
{
if (!is_array($data)) {
throw new \InvalidArgumentException(sprintf('Messages custom data must be array, "%s" given.', gettype($data)));
}
if (array_key_exists("aps", $data)) {
unset($data["aps"]);
}
foreach ($data as $key => $value) {
$this->addCustomData($key, $value);
}
return $this;
}
/**
* Add custom data
*
* @param string $key
* @param mixed $value
*/
public function addCustomData($key, $value)
{
if ($key == 'aps') {
throw new \LogicException('Can\'t replace "aps" data. Please call to setMessage, if your want replace message text.');
}
if (is_object($value)) {
if (interface_exists('JsonSerializable') && !$value instanceof \stdClass && !$value instanceof \JsonSerializable) {
throw new \InvalidArgumentException(sprintf(
'Object %s::%s must be implements JsonSerializable interface for next serialize data.',
get_class($value), spl_object_hash($value)
));
}
}
$this->customData[$key] = $value;
return $this;
}
/**
* Sets the identifier of the target device, eg UUID or similar
*
* @param $identifier
*/
public function setDeviceIdentifier($identifier)
{
$this->identifier = $identifier;
}
/**
* Gets the full message body to send to APN
*
* @return array
*/
public function getMessageBody()
{
$payloadBody = $this->apsBody;
if (!empty($this->customData)) {
$payloadBody = array_merge($payloadBody, $this->customData);
}
return $payloadBody;
}
/**
* Returns the device identifier
*
* @return null|string
*/
public function getDeviceIdentifier()
{
return $this->identifier;
}
/**
* Returns the target OS for this message
* Must be implemented by subclass
*
* @return string
*/
public function getTargetOS()
{
return "";
}
/**
* iOS-specific
* Sets the APS sound
*
* @param string $sound The sound to use. Use 'default' to use the built-in default
*/
public function setAPSSound($sound)
{
$this->apsBody["aps"]["sound"] = $sound;
}
/**
* iOS-specific
* Sets the APS badge count
*
* @param integer $badge The badge count to display
*/
public function setAPSBadge($badge)
{
$this->apsBody["aps"]["badge"] = (int) $badge;
}
/**
* iOS-specific
* Sets the APS content available flag, used to transform the notification into remote-notification
* and trigger the "didReceiveRemoteNotification: fetchCompletionHandler:" method on iOS apps
*
* @param string $contentAvailable The flag to set the content-available option, for example set it to 1.
*/
public function setAPSContentAvailable($contentAvailable)
{
$this->apsBody["aps"]["content-available"] = $contentAvailable;
}
/**
* iOS-specific
* Sets the APS category
*
* @param string $category The notification category
*/
public function setCategory($category)
{
$this->apsBody["aps"]["category"] = $category;
}
/**
* iOS-specific
* Sets the APS mutable-content attribute
*
* @param bool $mutableContent
*/
public function setMutableContent($mutableContent)
{
$this->apsBody["aps"]["mutable-content"] = $mutableContent ? 1 : 0;
}
/**
* Set expiry of message
*
* @param int $expiry
*/
public function setExpiry($expiry)
{
$this->expiry = $expiry;
}
/**
* Get expiry of message
*
* @return int
*/
public function getExpiry()
{
return $this->expiry;
}
/**
* @param string $pushMagicToken
*/
public function setPushMagicToken($pushMagicToken)
{
$this->pushMagicToken = $pushMagicToken;
}
/**
* @return string
*/
public function getPushMagicToken()
{
return $this->pushMagicToken;
}
/**
* @return string
*/
public function getToken()
{
return $this->token;
}
/**
* @param string $token
*/
public function setToken($token)
{
$this->token = $token;
}
/**
* @param null|bool $isMdmMessage
*
* @return bool|null
*/
public function isMdmMessage($isMdmMessage = null)
{
if ($isMdmMessage === null) {
return $this->isMdmMessage;
}
$this->isMdmMessage = (bool) $isMdmMessage;
}
}