forked from php-enqueue/sns
/
SnsMessage.php
223 lines (196 loc) · 5.04 KB
/
SnsMessage.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
<?php
declare(strict_types=1);
namespace Enqueue\Sns;
use Interop\Queue\Impl\MessageTrait;
use Interop\Queue\Message;
use Psr\Http\Message\StreamInterface;
class SnsMessage implements Message
{
use MessageTrait;
/**
* @var string|null
*/
private $snsMessageId;
/**
* @var string|null
*/
private $messageStructure;
/**
* @var string|null
*/
private $phoneNumber;
/**
* @var string|null
*/
private $subject;
/**
* @var array|null
*/
private $messageAttributes;
/**
* @var string|null
*/
private $targetArn;
/**
* SnsMessage constructor.
*
* See AWS documentation for message attribute structure.
*
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sns-2010-03-31.html#shape-messageattributevalue
*
* @param string $body
* @param array $properties
* @param array $headers
* @param array|null $messageAttributes
* @param string|null $messageStructure
* @param string|null $phoneNumber
* @param string|null $subject
* @param string|null $targetArn
*/
public function __construct(
string $body = '',
array $properties = [],
array $headers = [],
array $messageAttributes = null,
string $messageStructure = null,
string $phoneNumber = null,
string $subject = null,
string $targetArn = null
) {
$this->body = $body;
$this->properties = $properties;
$this->headers = $headers;
$this->messageAttributes = $messageAttributes;
$this->messageStructure = $messageStructure;
$this->phoneNumber = $phoneNumber;
$this->subject = $subject;
$this->targetArn = $targetArn;
$this->redelivered = false;
}
/**
* @return string|null
*/
public function getSnsMessageId(): ?string
{
return $this->snsMessageId;
}
/**
* @param string|null $snsMessageId
*/
public function setSnsMessageId(?string $snsMessageId): void
{
$this->snsMessageId = $snsMessageId;
}
/**
* @return string|null
*/
public function getMessageStructure(): ?string
{
return $this->messageStructure;
}
/**
* @param string|null $messageStructure
*/
public function setMessageStructure(?string $messageStructure): void
{
$this->messageStructure = $messageStructure;
}
/**
* @return string|null
*/
public function getPhoneNumber(): ?string
{
return $this->phoneNumber;
}
/**
* @param string|null $phoneNumber
*/
public function setPhoneNumber(?string $phoneNumber): void
{
$this->phoneNumber = $phoneNumber;
}
/**
* @return string|null
*/
public function getSubject(): ?string
{
return $this->subject;
}
/**
* @param string|null $subject
*/
public function setSubject(?string $subject): void
{
$this->subject = $subject;
}
/**
* @return array|null
*/
public function getMessageAttributes(): ?array
{
return $this->messageAttributes;
}
/**
* @param array|null $messageAttributes
*/
public function setMessageAttributes(?array $messageAttributes): void
{
$this->messageAttributes = $messageAttributes;
}
/**
* @param string $name
* @param null $default
*
* @return array|null
*/
public function getAttribute(string $name, $default = null)
{
return array_key_exists($name, $this->messageAttributes) ? $this->messageAttributes[$name] : $default;
}
/**
* Attribute array format:
* [
* 'BinaryValue' => <string || resource || Psr\Http\Message\StreamInterface>,
* 'DataType' => '<string>', // REQUIRED
* 'StringValue' => '<string>',
* ].
*
* @param string $name
* @param array|null $attribute
*/
public function setAttribute(string $name, ?array $attribute): void
{
if (null === $attribute) {
unset($this->messageAttributes[$name]);
} else {
$this->messageAttributes[$name] = $attribute;
}
}
/**
* @param string $name
* @param string $dataType String, String.Array, Number, or Binary
* @param string|resource|StreamInterface $value
*/
public function addAttribute(string $name, string $dataType, $value): void
{
$valueKey = 'Binary' === $dataType ? 'BinaryValue' : 'StringValue';
$this->messageAttributes[$name] = [
'DataType' => $dataType,
$valueKey => $value,
];
}
/**
* @return string|null
*/
public function getTargetArn(): ?string
{
return $this->targetArn;
}
/**
* @param string|null $targetArn
*/
public function setTargetArn(?string $targetArn): void
{
$this->targetArn = $targetArn;
}
}