Skip to content

Commit 369bcc9

Browse files
makasimmakasim
authored
Merge pull request #45 from php-enqueue/add-psr-prefix-to-classes
[transport] Add Psr prefix to transport interfaces. Deprecates old ones.
2 parents d37ff2b + 5e2d909 commit 369bcc9

File tree

138 files changed

+1046
-986
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

138 files changed

+1046
-986
lines changed

‎docs/bundle/job_queue.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ Guaranty that there is only single job running with such name.
1414

1515
```php
1616
<?php
17-
use Enqueue\Psr\Message;
18-
use Enqueue\Psr\Processor;
19-
use Enqueue\Psr\Context;
17+
use Enqueue\Psr\PsrMessage;
18+
use Enqueue\Psr\PsrProcessor;
19+
use Enqueue\Psr\PsrContext;
2020
use Enqueue\Util\JSON;
2121
use Enqueue\JobQueue\JobRunner;
2222
use Enqueue\JobQueue\Job;
2323

24-
class ReindexProcessor implements Processor
24+
class ReindexProcessor implements PsrProcessor
2525
{
2626
/**
2727
* @var JobRunner
2828
*/
2929
private $jobRunner;
3030

31-
public function process(Message $message, Context $context)
31+
public function process(PsrMessage $message, PsrContext $context)
3232
{
3333
$data = JSON::decode($message->getBody());
3434

@@ -57,11 +57,11 @@ use Enqueue\JobQueue\JobRunner;
5757
use Enqueue\JobQueue\Job;
5858
use Enqueue\Client\ProducerInterface;
5959
use Enqueue\Util\JSON;
60-
use Enqueue\Psr\Message;
61-
use Enqueue\Psr\Context;
62-
use Enqueue\Psr\Processor;
60+
use Enqueue\Psr\PsrMessage;
61+
use Enqueue\Psr\PsrContext;
62+
use Enqueue\Psr\PsrProcessor;
6363

64-
class Step1Processor implements Processor
64+
class Step1Processor implements PsrProcessor
6565
{
6666
/**
6767
* @var JobRunner
@@ -73,7 +73,7 @@ class Step1Processor implements Processor
7373
*/
7474
private $producer;
7575

76-
public function process(Message $message, Context $context)
76+
public function process(PsrMessage $message, PsrContext $context)
7777
{
7878
$data = JSON::decode($message->getBody());
7979

@@ -104,14 +104,14 @@ class Step1Processor implements Processor
104104
}
105105
}
106106

107-
class Step2Processor implements Processor
107+
class Step2Processor implements PsrProcessor
108108
{
109109
/**
110110
* @var JobRunner
111111
*/
112112
private $jobRunner;
113113

114-
public function process(Message $message, Context $context)
114+
public function process(PsrMessage $message, PsrContext $context)
115115
{
116116
$data = JSON::decode($message->getBody());
117117

@@ -124,7 +124,7 @@ class Step2Processor implements Processor
124124
}
125125
);
126126

127-
return $result ? Result::ACK : Result::REJECT;
127+
return $result ? self::ACK : self::REJECT;
128128
}
129129
}
130130
```
@@ -140,11 +140,11 @@ use Enqueue\JobQueue\JobRunner;
140140
use Enqueue\JobQueue\Job;
141141
use Enqueue\JobQueue\DependentJobService;
142142
use Enqueue\Util\JSON;
143-
use Enqueue\Psr\Message;
144-
use Enqueue\Psr\Context;
145-
use Enqueue\Psr\Processor;
143+
use Enqueue\Psr\PsrMessage;
144+
use Enqueue\Psr\PsrContext;
145+
use Enqueue\Psr\PsrProcessor;
146146

147-
class ReindexProcessor implements Processor
147+
class ReindexProcessor implements PsrProcessor
148148
{
149149
/**
150150
* @var JobRunner
@@ -156,7 +156,7 @@ class ReindexProcessor implements Processor
156156
*/
157157
private $dependentJob;
158158

159-
public function process(Message $message, Context $context)
159+
public function process(PsrMessage $message, PsrContext $context)
160160
{
161161
$data = JSON::decode($message->getBody());
162162

‎docs/bundle/message_processor.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ It allows to keep subscription login and process logic closer to each other.
3535
namespace AppBundle\Async;
3636
3737
use Enqueue\Client\TopicSubscriberInterface;
38-
use Enqueue\Psr\Processor;
38+
use Enqueue\Psr\PsrProcessor;
3939
40-
class SayHelloProcessor implements Processor, TopicSubscriberInterface
40+
class SayHelloProcessor implements PsrProcessor, TopicSubscriberInterface
4141
{
4242
public static function getSubscribedTopics()
4343
{
@@ -51,9 +51,9 @@ On the topic subscriber you can also define queue and processor name:
5151
```php
5252
<?php
5353
use Enqueue\Client\TopicSubscriberInterface;
54-
use Enqueue\Psr\Processor;
54+
use Enqueue\Psr\PsrProcessor;
5555
56-
class SayHelloProcessor implements Processor, TopicSubscriberInterface
56+
class SayHelloProcessor implements PsrProcessor, TopicSubscriberInterface
5757
{
5858
public static function getSubscribedTopics()
5959
{

‎docs/bundle/quick_tour.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,14 @@ To consume messages you have to first create a message processor:
7171

7272
```php
7373
<?php
74-
use Enqueue\Psr\Message;
75-
use Enqueue\Psr\Context;
76-
use Enqueue\Psr\Processor;
74+
use Enqueue\Psr\PsrMessage;
75+
use Enqueue\Psr\PsrContext;
76+
use Enqueue\Psr\PsrProcessor;
7777
use Enqueue\Client\TopicSubscriberInterface;
7878

79-
class FooProcessor implements Processor, TopicSubscriberInterface
79+
class FooProcessor implements PsrProcessor, TopicSubscriberInterface
8080
{
81-
public function process(Message $message, Context $session)
81+
public function process(PsrMessage $message, PsrContext $session)
8282
{
8383
echo $message->getBody();
8484

‎docs/consumption/message_processor.md

+26-26
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ Here's example:
55

66
```php
77
<?php
8-
use Enqueue\Psr\Processor;
9-
use Enqueue\Psr\Message;
10-
use Enqueue\Psr\Context;
8+
use Enqueue\Psr\PsrProcessor;
9+
use Enqueue\Psr\PsrMessage;
10+
use Enqueue\Psr\PsrContext;
1111

12-
class SendMailProcessor implements Processor
12+
class SendMailProcessor implements PsrProcessor
1313
{
14-
public function process(Message $message, Context $context)
14+
public function process(PsrMessage $message, PsrContext $context)
1515
{
1616
$this->mailer->send('foo@example.com', $message->getBody());
1717

@@ -26,14 +26,14 @@ Sometimes you have to reject messages explicitly.
2626

2727
```php
2828
<?php
29-
use Enqueue\Psr\Processor;
30-
use Enqueue\Psr\Message;
31-
use Enqueue\Psr\Context;
29+
use Enqueue\Psr\PsrProcessor;
30+
use Enqueue\Psr\PsrMessage;
31+
use Enqueue\Psr\PsrContext;
3232
use Enqueue\Util\JSON;
3333

34-
class SendMailProcessor implements Processor
34+
class SendMailProcessor implements PsrProcessor
3535
{
36-
public function process(Message $message, Context $context)
36+
public function process(PsrMessage $message, PsrContext $context)
3737
{
3838
$data = JSON::decode($message->getBody());
3939
if ($user = $this->userRepository->find($data['userId'])) {
@@ -53,13 +53,13 @@ If it returns true than there was attempt to process message.
5353

5454
```php
5555
<?php
56-
use Enqueue\Psr\Processor;
57-
use Enqueue\Psr\Message;
58-
use Enqueue\Psr\Context;
56+
use Enqueue\Psr\PsrProcessor;
57+
use Enqueue\Psr\PsrMessage;
58+
use Enqueue\Psr\PsrContext;
5959

60-
class SendMailProcessor implements Processor
60+
class SendMailProcessor implements PsrProcessor
6161
{
62-
public function process(Message $message, Context $context)
62+
public function process(PsrMessage $message, PsrContext $context)
6363
{
6464
if ($message->isRedelivered()) {
6565
return self::REQUEUE;
@@ -76,13 +76,13 @@ The second argument is your context. You can use it to send messages to other qu
7676

7777
```php
7878
<?php
79-
use Enqueue\Psr\Processor;
80-
use Enqueue\Psr\Message;
81-
use Enqueue\Psr\Context;
79+
use Enqueue\Psr\PsrProcessor;
80+
use Enqueue\Psr\PsrMessage;
81+
use Enqueue\Psr\PsrContext;
8282

83-
class SendMailProcessor implements Processor
83+
class SendMailProcessor implements PsrProcessor
8484
{
85-
public function process(Message $message, Context $context)
85+
public function process(PsrMessage $message, PsrContext $context)
8686
{
8787
$this->mailer->send('foo@example.com', $message->getBody());
8888

@@ -99,17 +99,17 @@ The consumption component provide some useful extensions, for example there is a
9999

100100
```php
101101
<?php
102-
use Enqueue\Psr\Processor;
103-
use Enqueue\Psr\Message;
104-
use Enqueue\Psr\Context;
102+
use Enqueue\Psr\PsrProcessor;
103+
use Enqueue\Psr\PsrMessage;
104+
use Enqueue\Psr\PsrContext;
105105
use Enqueue\Consumption\ChainExtension;
106106
use Enqueue\Consumption\QueueConsumer;
107107
use Enqueue\Consumption\Extension\ReplyExtension;
108108
use Enqueue\Consumption\Result;
109109

110-
class SendMailProcessor implements Processor
110+
class SendMailProcessor implements PsrProcessor
111111
{
112-
public function process(Message $message, Context $context)
112+
public function process(PsrMessage $message, PsrContext $context)
113113
{
114114
$this->mailer->send('foo@example.com', $message->getBody());
115115

@@ -119,7 +119,7 @@ class SendMailProcessor implements Processor
119119
}
120120
}
121121

122-
/** @var \Enqueue\Psr\Context $psrContext */
122+
/** @var \Enqueue\Psr\PsrContext $psrContext */
123123

124124
$queueConsumer = new QueueConsumer($psrContext, new ChainExtension([
125125
new ReplyExtension()

‎docs/job_queue/run_sub_job.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,22 @@ They will be executed in parallel.
77
```php
88
<?php
99
use Enqueue\Client\ProducerInterface;
10-
use Enqueue\Psr\Message;
11-
use Enqueue\Psr\Context;
12-
use Enqueue\Psr\Processor;
10+
use Enqueue\Psr\PsrMessage;
11+
use Enqueue\Psr\PsrContext;
12+
use Enqueue\Psr\PsrProcessor;
1313
use Enqueue\JobQueue\JobRunner;
1414
use Enqueue\JobQueue\Job;
1515
use Enqueue\Util\JSON;
1616

17-
class RootJobProcessor implements Processor
17+
class RootJobProcessor implements PsrProcessor
1818
{
1919
/** @var JobRunner */
2020
private $jobRunner;
2121

2222
/** @var ProducerInterface */
2323
private $producer;
2424

25-
public function process(Message $message, Context $context)
25+
public function process(PsrMessage $message, PsrContext $context)
2626
{
2727
$result = $this->jobRunner->runUnique($message->getMessageId(), 'aJobName', function (JobRunner $runner) {
2828
$runner->createDelayed('aSubJobName1', function (JobRunner $runner, Job $childJob) {
@@ -39,12 +39,12 @@ class RootJobProcessor implements Processor
3939
}
4040
}
4141

42-
class SubJobProcessor implements Processor
42+
class SubJobProcessor implements PsrProcessor
4343
{
4444
/** @var JobRunner */
4545
private $jobRunner;
4646

47-
public function process(Message $message, Context $context)
47+
public function process(PsrMessage $message, PsrContext $context)
4848
{
4949
$data = JSON::decode($message->getBody());
5050

@@ -54,7 +54,7 @@ class SubJobProcessor implements Processor
5454
return true;
5555
});
5656

57-
return $result ? Result::ACK : Result::REJECT;
57+
return $result ? self::ACK : self::REJECT;
5858
}
5959
}
6060
```

‎docs/job_queue/run_unique_job.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@ It shows how you can run unique job using job queue (The configuration is descri
1212

1313
```php
1414
<?php
15-
use Enqueue\Psr\Message;
16-
use Enqueue\Psr\Context;
17-
use Enqueue\Psr\Processor;
15+
use Enqueue\Psr\PsrMessage;
16+
use Enqueue\Psr\PsrContext;
17+
use Enqueue\Psr\PsrProcessor;
1818
use Enqueue\JobQueue\JobRunner;
1919

20-
class UniqueJobProcessor implements Processor
20+
class UniqueJobProcessor implements PsrProcessor
2121
{
2222
/** @var JobRunner */
2323
private $jobRunner;
2424

25-
public function process(Message $message, Context $context)
25+
public function process(PsrMessage $message, PsrContext $context)
2626
{
2727
$result = $this->jobRunner->runUnique($message->getMessageId(), 'aJobName', function () {
2828
// do your job, there is no any other processes executing same job,

0 commit comments

Comments
 (0)