-
Notifications
You must be signed in to change notification settings - Fork 21
Expand file tree
/
Copy pathMessage.php
More file actions
181 lines (158 loc) · 4.56 KB
/
Message.php
File metadata and controls
181 lines (158 loc) · 4.56 KB
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
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org/)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org/)
* @link https://cakephp.org CakePHP(tm) Project
* @since 0.1.0
* @license https://opensource.org/licenses/MIT MIT License
*/
namespace Cake\Queue\Job;
use Cake\Core\ContainerInterface;
use Cake\Utility\Hash;
use Closure;
use Interop\Queue\Context;
use Interop\Queue\Message as QueueMessage;
use JsonSerializable;
use RuntimeException;
class Message implements JsonSerializable
{
/**
* @var array<string, mixed>
*/
protected array $parsedBody;
protected ?Closure $callable = null;
/**
* @param \Interop\Queue\Message $originalMessage Queue message.
* @param \Interop\Queue\Context $context Context.
* @param \Cake\Core\ContainerInterface|null $container DI container instance
*/
public function __construct(
protected readonly QueueMessage $originalMessage,
protected readonly Context $context,
protected readonly ?ContainerInterface $container = null,
) {
$this->parsedBody = json_decode($originalMessage->getBody(), true);
}
/**
* Get the queue context.
*
* @return \Interop\Queue\Context
*/
public function getContext(): Context
{
return $this->context;
}
/**
* Get the original queue message.
*
* @return \Interop\Queue\Message
*/
public function getOriginalMessage(): QueueMessage
{
return $this->originalMessage;
}
/**
* Get the parsed message body.
*
* @return array<string, mixed>
*/
public function getParsedBody(): array
{
return $this->parsedBody;
}
/**
* Get a closure containing the callable in the job.
*
* Supported callables include:
* - array of [class, method]. The class will be constructed with no constructor parameters.
*
* @return \Closure
*/
public function getCallable(): Closure
{
if ($this->callable instanceof Closure) {
return $this->callable;
}
$target = $this->getTarget();
if ($this->container && $this->container->has($target[0])) {
$object = $this->container->get($target[0]);
} else {
$object = new $target[0]();
}
$this->callable = Closure::fromCallable([$object, $target[1]]);
return $this->callable;
}
/**
* Get the target class and method.
*
* @return array{string, string}
* @phpstan-return array{class-string, string}
*/
public function getTarget(): array
{
/** @var array{class-string, string}|null $target */
$target = $this->parsedBody['class'] ?? null;
if (!is_array($target) || count($target) !== 2) {
throw new RuntimeException(sprintf(
'Message class should be in the form `[class, method]` got `%s`',
json_encode($target),
));
}
return $target;
}
/**
* @param mixed $key Key
* @param mixed $default Default value.
* @return mixed
*/
public function getArgument(mixed $key = null, mixed $default = null): mixed
{
// support old jobs that still use args key
if (array_key_exists('data', $this->parsedBody)) {
$data = $this->parsedBody['data'];
} else {
// support old jobs that still use args key
$data = $this->parsedBody['args'][0];
}
if ($key === null) {
return $data;
}
return Hash::get($data, $key, $default);
}
/**
* The maximum number of attempts allowed by the job.
*
* @return int|null
*/
public function getMaxAttempts(): ?int
{
$target = $this->getTarget();
$class = $target[0];
return $class::$maxAttempts ?? null;
}
/**
* Convert the message to a string representation.
*
* @return string
*/
public function __toString(): string
{
return (string)json_encode($this);
}
/**
* Serialize the message to JSON.
*
* @return array<string, mixed>
*/
public function jsonSerialize(): array
{
return $this->parsedBody;
}
}