Skip to content

Commit 16a9490

Browse files
makasimmakasim
authored
Merge pull request #603 from yurez/master
[docs] Fixed docs. Removed prefix Psr.
2 parents dfc6768 + e43a063 commit 16a9490

31 files changed

+461
-461
lines changed

‎docs/async_event_dispatcher/quick_tour.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ $dispatcher->dispatch('the_event', new GenericEvent('theSubject'));
8181

8282
// consume.php
8383

84-
use Interop\Queue\PsrProcessor;
84+
use Interop\Queue\Processor;
8585

8686
require_once __DIR__.'/vendor/autoload.php';
8787
include __DIR__.'/config.php';
@@ -93,13 +93,13 @@ while (true) {
9393
$result = $asyncProcessor->process($message, $context);
9494

9595
switch ((string) $result) {
96-
case PsrProcessor::ACK:
96+
case Processor::ACK:
9797
$consumer->acknowledge($message);
9898
break;
99-
case PsrProcessor::REJECT:
99+
case Processor::REJECT:
100100
$consumer->reject($message);
101101
break;
102-
case PsrProcessor::REQUEUE:
102+
case Processor::REQUEUE:
103103
$consumer->reject($message, true);
104104
break;
105105
default:

‎docs/bundle/async_events.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ namespace AcmeBundle\Listener;
8787
8888
use Enqueue\Client\Message;
8989
use Enqueue\Consumption\Result;
90-
use Interop\Queue\PsrMessage;
90+
use Interop\Queue\Message as QueueMessage;
9191
use Enqueue\Util\JSON;
9292
use Symfony\Component\EventDispatcher\Event;
9393
use Enqueue\AsyncEventDispatcher\EventTransformer;
@@ -132,7 +132,7 @@ class FooEventTransformer implements EventTransformer
132132
/**
133133
* {@inheritdoc}
134134
*/
135-
public function toEvent($eventName, PsrMessage $message)
135+
public function toEvent($eventName, QueueMessage $message)
136136
{
137137
$data = JSON::decode($message->getBody());
138138

‎docs/bundle/config_reference.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ enqueue:
1212
# The broker DSN. These schemes are supported: "file", "amqp", "amqps", "db2", "ibm-db2", "mssql", "sqlsrv", "mysql", "mysql2", "pgsql", "postgres", "sqlite", "sqlite3", "null", "gearman", "beanstalk", "kafka", "rdkafka", "redis", "stomp", "sqs", "gps", "mongodb", to use these "file", "amqp", "amqps", "db2", "ibm-db2", "mssql", "sqlsrv", "mysql", "mysql2", "pgsql", "postgres", "sqlite", "sqlite3", "null", "gearman", "beanstalk", "kafka", "rdkafka", "redis", "stomp", "sqs", "gps", "mongodb" you have to install a package.
1313
dsn: ~ # Required
1414

15-
# The connection factory class should implement "Interop\Queue\PsrConnectionFactory" interface
15+
# The connection factory class should implement "Interop\Queue\ConnectionFactory" interface
1616
connection_factory_class: ~
1717

1818
# The factory class should implement "Enqueue\ConnectionFactoryFactoryInterface" interface

‎docs/bundle/job_queue.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -84,15 +84,15 @@ Here's how to do it:
8484
<?php
8585
namespace App\Queue;
8686

87-
use Interop\Queue\PsrMessage;
88-
use Interop\Queue\PsrProcessor;
89-
use Interop\Queue\PsrContext;
87+
use Interop\Queue\Message;
88+
use Interop\Queue\Processor;
89+
use Interop\Queue\Context;
9090
use Enqueue\Util\JSON;
9191
use Enqueue\JobQueue\JobRunner;
9292
use Enqueue\JobQueue\Job;
9393
use Enqueue\Client\CommandSubscriberInterface;
9494

95-
class SearchReindexProcessor implements PsrProcessor, CommandSubscriberInterface
95+
class SearchReindexProcessor implements Processor, CommandSubscriberInterface
9696
{
9797
private $jobRunner;
9898

@@ -101,7 +101,7 @@ class SearchReindexProcessor implements PsrProcessor, CommandSubscriberInterface
101101
$this->jobRunner = $jobRunner;
102102
}
103103

104-
public function process(PsrMessage $message, PsrContext $context)
104+
public function process(Message $message, Context $context)
105105
{
106106
$data = JSON::decode($message->getBody());
107107

@@ -160,11 +160,11 @@ use Enqueue\JobQueue\JobRunner;
160160
use Enqueue\JobQueue\Job;
161161
use Enqueue\Client\ProducerInterface;
162162
use Enqueue\Util\JSON;
163-
use Interop\Queue\PsrMessage;
164-
use Interop\Queue\PsrContext;
165-
use Interop\Queue\PsrProcessor;
163+
use Interop\Queue\Message;
164+
use Interop\Queue\Context;
165+
use Interop\Queue\Processor;
166166

167-
class Step1Processor implements PsrProcessor
167+
class Step1Processor implements Processor
168168
{
169169
/**
170170
* @var JobRunner
@@ -176,7 +176,7 @@ class Step1Processor implements PsrProcessor
176176
*/
177177
private $producer;
178178

179-
public function process(PsrMessage $message, PsrContext $context)
179+
public function process(Message $message, Context $context)
180180
{
181181
$data = JSON::decode($message->getBody());
182182

@@ -207,14 +207,14 @@ class Step1Processor implements PsrProcessor
207207
}
208208
}
209209

210-
class Step2Processor implements PsrProcessor
210+
class Step2Processor implements Processor
211211
{
212212
/**
213213
* @var JobRunner
214214
*/
215215
private $jobRunner;
216216

217-
public function process(PsrMessage $message, PsrContext $context)
217+
public function process(Message $message, Context $context)
218218
{
219219
$data = JSON::decode($message->getBody());
220220

@@ -244,11 +244,11 @@ use Enqueue\JobQueue\JobRunner;
244244
use Enqueue\JobQueue\Job;
245245
use Enqueue\JobQueue\DependentJobService;
246246
use Enqueue\Util\JSON;
247-
use Interop\Queue\PsrMessage;
248-
use Interop\Queue\PsrContext;
249-
use Interop\Queue\PsrProcessor;
247+
use Interop\Queue\Message;
248+
use Interop\Queue\Context;
249+
use Interop\Queue\Processor;
250250

251-
class ReindexProcessor implements PsrProcessor
251+
class ReindexProcessor implements Processor
252252
{
253253
/**
254254
* @var JobRunner
@@ -260,7 +260,7 @@ class ReindexProcessor implements PsrProcessor
260260
*/
261261
private $dependentJob;
262262

263-
public function process(PsrMessage $message, PsrContext $context)
263+
public function process(Message $message, Context $context)
264264
{
265265
$data = JSON::decode($message->getBody());
266266

‎docs/bundle/message_processor.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ It is handy to subscribe on event messages. It allows to keep subscription login
3636
namespace AppBundle\Async;
3737
3838
use Enqueue\Client\TopicSubscriberInterface;
39-
use Interop\Queue\PsrProcessor;
39+
use Interop\Queue\Processor;
4040
41-
class SayHelloProcessor implements PsrProcessor, TopicSubscriberInterface
41+
class SayHelloProcessor implements Processor, TopicSubscriberInterface
4242
{
4343
public static function getSubscribedTopics()
4444
{
@@ -52,9 +52,9 @@ On the topic subscriber you can also define queue and processor name:
5252
```php
5353
<?php
5454
use Enqueue\Client\TopicSubscriberInterface;
55-
use Interop\Queue\PsrProcessor;
55+
use Interop\Queue\Processor;
5656
57-
class SayHelloProcessor implements PsrProcessor, TopicSubscriberInterface
57+
class SayHelloProcessor implements Processor, TopicSubscriberInterface
5858
{
5959
public static function getSubscribedTopics()
6060
{
@@ -89,9 +89,9 @@ If you send a message using ProducerV2::sendCommand('aCommandName') method it wi
8989
namespace AppBundle\Async;
9090
9191
use Enqueue\Client\CommandSubscriberInterface;
92-
use Interop\Queue\PsrProcessor;
92+
use Interop\Queue\Processor;
9393
94-
class SayHelloProcessor implements PsrProcessor, CommandSubscriberInterface
94+
class SayHelloProcessor implements Processor, CommandSubscriberInterface
9595
{
9696
public static function getSubscribedCommand()
9797
{
@@ -105,9 +105,9 @@ On the command subscriber you can also define additional settings such as queue
105105
```php
106106
<?php
107107
use Enqueue\Client\CommandSubscriberInterface;
108-
use Interop\Queue\PsrProcessor;
108+
use Interop\Queue\Processor;
109109
110-
class SayHelloProcessor implements PsrProcessor, CommandSubscriberInterface
110+
class SayHelloProcessor implements Processor, CommandSubscriberInterface
111111
{
112112
public static function getSubscribedCommand()
113113
{
@@ -124,9 +124,9 @@ In the container you can just add the tag `enqueue.client.message_processor` and
124124
```php
125125
<?php
126126
use Enqueue\Client\CommandSubscriberInterface;
127-
use Interop\Queue\PsrProcessor;
127+
use Interop\Queue\Processor;
128128
129-
class SayHelloProcessor implements PsrProcessor, CommandSubscriberInterface
129+
class SayHelloProcessor implements Processor, CommandSubscriberInterface
130130
{
131131
public static function getSubscribedCommand()
132132
{

‎docs/bundle/message_producer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Transport gives you the access to all transport specific features so you can tun
1010

1111
/** @var Symfony\Component\DependencyInjection\ContainerInterface $container */
1212

13-
/** @var Interop\Queue\PsrContext $context */
13+
/** @var Interop\Queue\Context $context */
1414
$context = $container->get('enqueue.transport.context');
1515

1616
$context->createProducer()->send(

‎docs/bundle/quick_tour.md

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

7474
```php
7575
<?php
76-
use Interop\Queue\PsrMessage;
77-
use Interop\Queue\PsrContext;
78-
use Interop\Queue\PsrProcessor;
76+
use Interop\Queue\Message;
77+
use Interop\Queue\Context;
78+
use Interop\Queue\Processor;
7979
use Enqueue\Client\TopicSubscriberInterface;
8080

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

‎docs/client/quick_tour.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -84,15 +84,15 @@ $replyMessage->getBody();
8484
```php
8585
<?php
8686

87-
use Interop\Queue\PsrMessage;
88-
use Interop\Queue\PsrProcessor;
87+
use Interop\Queue\Message;
88+
use Interop\Queue\Processor;
8989

9090
/** @var \Enqueue\SimpleClient\SimpleClient $client */
9191

92-
$client->bindTopic('a_bar_topic', function(PsrMessage $psrMessage) {
92+
$client->bindTopic('a_bar_topic', function(Message $psrMessage) {
9393
// processing logic here
9494

95-
return PsrProcessor::ACK;
95+
return Processor::ACK;
9696
});
9797

9898
$client->consume();

‎docs/client/rpc_call.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,19 @@ Of course it is possible to implement rpc server side based on transport classes
1414
```php
1515
<?php
1616

17-
use Interop\Queue\PsrMessage;
18-
use Interop\Queue\PsrContext;
17+
use Interop\Queue\Message;
18+
use Interop\Queue\Context;
1919
use Enqueue\Consumption\Result;
2020
use Enqueue\Consumption\ChainExtension;
2121
use Enqueue\Consumption\Extension\ReplyExtension;
2222
use Enqueue\SimpleClient\SimpleClient;
2323

24-
/** @var \Interop\Queue\PsrContext $context */
24+
/** @var \Interop\Queue\Context $context */
2525

2626
// composer require enqueue/amqp-ext # or enqueue/amqp-bunny, enqueue/amqp-lib
2727
$client = new SimpleClient('amqp:');
2828

29-
$client->bindCommand('square', function (PsrMessage $message, PsrContext $context) use (&$requestMessage) {
29+
$client->bindCommand('square', function (Message $message, Context $context) use (&$requestMessage) {
3030
$number = (int) $message->getBody();
3131

3232
return Result::reply($context->createMessage($number ^ 2));

‎docs/consumption/message_processor.md

+27-27
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ Here's example:
1313

1414
```php
1515
<?php
16-
use Interop\Queue\PsrProcessor;
17-
use Interop\Queue\PsrMessage;
18-
use Interop\Queue\PsrContext;
16+
use Interop\Queue\Processor;
17+
use Interop\Queue\Message;
18+
use Interop\Queue\Context;
1919

20-
class SendMailProcessor implements PsrProcessor
20+
class SendMailProcessor implements Processor
2121
{
22-
public function process(PsrMessage $message, PsrContext $context)
22+
public function process(Message $message, Context $context)
2323
{
2424
$this->mailer->send('foo@example.com', $message->getBody());
2525

@@ -40,14 +40,14 @@ Look at the next example that shows the message validation before sending a mail
4040

4141
```php
4242
<?php
43-
use Interop\Queue\PsrProcessor;
44-
use Interop\Queue\PsrMessage;
45-
use Interop\Queue\PsrContext;
43+
use Interop\Queue\Processor;
44+
use Interop\Queue\Message;
45+
use Interop\Queue\Context;
4646
use Enqueue\Util\JSON;
4747

48-
class SendMailProcessor implements PsrProcessor
48+
class SendMailProcessor implements Processor
4949
{
50-
public function process(PsrMessage $message, PsrContext $context)
50+
public function process(Message $message, Context $context)
5151
{
5252
$data = JSON::decode($message->getBody());
5353
if ($user = $this->userRepository->find($data['userId'])) {
@@ -67,13 +67,13 @@ If it returns true than there was attempt to process message.
6767

6868
```php
6969
<?php
70-
use Interop\Queue\PsrProcessor;
71-
use Interop\Queue\PsrMessage;
72-
use Interop\Queue\PsrContext;
70+
use Interop\Queue\Processor;
71+
use Interop\Queue\Message;
72+
use Interop\Queue\Context;
7373

74-
class SendMailProcessor implements PsrProcessor
74+
class SendMailProcessor implements Processor
7575
{
76-
public function process(PsrMessage $message, PsrContext $context)
76+
public function process(Message $message, Context $context)
7777
{
7878
if ($message->isRedelivered()) {
7979
return self::REQUEUE;
@@ -90,13 +90,13 @@ The second argument is your context. You can use it to send messages to other qu
9090

9191
```php
9292
<?php
93-
use Interop\Queue\PsrProcessor;
94-
use Interop\Queue\PsrMessage;
95-
use Interop\Queue\PsrContext;
93+
use Interop\Queue\Processor;
94+
use Interop\Queue\Message;
95+
use Interop\Queue\Context;
9696

97-
class SendMailProcessor implements PsrProcessor
97+
class SendMailProcessor implements Processor
9898
{
99-
public function process(PsrMessage $message, PsrContext $context)
99+
public function process(Message $message, Context $context)
100100
{
101101
$this->mailer->send('foo@example.com', $message->getBody());
102102

@@ -117,17 +117,17 @@ Don't forget to add `ReplyExtension`.
117117

118118
```php
119119
<?php
120-
use Interop\Queue\PsrProcessor;
121-
use Interop\Queue\PsrMessage;
122-
use Interop\Queue\PsrContext;
120+
use Interop\Queue\Processor;
121+
use Interop\Queue\Message;
122+
use Interop\Queue\Context;
123123
use Enqueue\Consumption\ChainExtension;
124124
use Enqueue\Consumption\QueueConsumer;
125125
use Enqueue\Consumption\Extension\ReplyExtension;
126126
use Enqueue\Consumption\Result;
127127

128-
class SendMailProcessor implements PsrProcessor
128+
class SendMailProcessor implements Processor
129129
{
130-
public function process(PsrMessage $message, PsrContext $context)
130+
public function process(Message $message, Context $context)
131131
{
132132
$this->mailer->send('foo@example.com', $message->getBody());
133133

@@ -137,9 +137,9 @@ class SendMailProcessor implements PsrProcessor
137137
}
138138
}
139139

140-
/** @var \Interop\Queue\PsrContext $psrContext */
140+
/** @var \Interop\Queue\Context $context */
141141

142-
$queueConsumer = new QueueConsumer($psrContext, new ChainExtension([
142+
$queueConsumer = new QueueConsumer($context, new ChainExtension([
143143
new ReplyExtension()
144144
]));
145145

0 commit comments

Comments
 (0)