Merge pull request #2274 from RudIhor/fix/improve-php-tutorials

michaelklishin · web-flow · commit 220232aa986f · 2025-05-24T18:08:56.000+04:00
docs(php): improve PHP documentation with the PHP7 capabilities
diff --git a/tutorials/tutorial-five-php.md b/tutorials/tutorial-five-php.md
@@ -138,7 +138,7 @@ $channel = $connection->channel();
 
 $channel->exchange_declare('topic_logs', 'topic', false, false, false);
 
-$routing_key = isset($argv[1]) && !empty($argv[1]) ? $argv[1] : 'anonymous.info';
+$routing_key = $argv[1] ?? 'anonymous.info';
 $data = implode(' ', array_slice($argv, 2));
 if (empty($data)) {
     $data = "Hello World!";
@@ -161,6 +161,7 @@ The code for `receive_logs_topic.php`:
 
 require_once __DIR__ . '/vendor/autoload.php';
 use PhpAmqpLib\Connection\AMQPStreamConnection;
+use PhpAmqpLib\Message\AMQPMessage;
 
 $connection = new AMQPStreamConnection('localhost', 5672, 'guest', 'guest');
 $channel = $connection->channel();
@@ -181,7 +182,7 @@ foreach ($binding_keys as $binding_key) {
 
 echo " [*] Waiting for logs. To exit press CTRL+C\n";
 
-$callback = function ($msg) {
+$callback = function (AMQPMessage $msg) {
     echo ' [x] ', $msg->getRoutingKey(), ':', $msg->getBody(), "\n";
 };
 
diff --git a/tutorials/tutorial-four-php.md b/tutorials/tutorial-four-php.md
@@ -168,7 +168,7 @@ $channel = $connection->channel();
 
 $channel->exchange_declare('direct_logs', 'direct', false, false, false);
 
-$severity = isset($argv[1]) && !empty($argv[1]) ? $argv[1] : 'info';
+$severity = $argv[1] ?? 'info';
 
 $data = implode(' ', array_slice($argv, 2));
 if (empty($data)) {
@@ -193,6 +193,7 @@ The code for `receive_logs_direct.php`:
 
 require_once __DIR__ . '/vendor/autoload.php';
 use PhpAmqpLib\Connection\AMQPStreamConnection;
+use PhpAmqpLib\Message\AMQPMessage;
 
 $connection = new AMQPStreamConnection('localhost', 5672, 'guest', 'guest');
 $channel = $connection->channel();
@@ -213,7 +214,7 @@ foreach ($severities as $severity) {
 
 echo " [*] Waiting for logs. To exit press CTRL+C\n";
 
-$callback = function ($msg) {
+$callback = function (AMQPMessage $msg) {
     echo ' [x] ', $msg->getRoutingKey(), ':', $msg->getBody(), "\n";
 };
 
diff --git a/tutorials/tutorial-one-php.md b/tutorials/tutorial-one-php.md
@@ -168,6 +168,7 @@ The code (in [`receive.php`](https://github.com/rabbitmq/rabbitmq-tutorials/blob
 ```php
 require_once __DIR__ . '/vendor/autoload.php';
 use PhpAmqpLib\Connection\AMQPStreamConnection;
+use PhpAmqpLib\Message\AMQPMessage;
 ```
 
 Setting up is the same as the publisher; we open a connection and a
@@ -193,7 +194,7 @@ that will receive the messages sent by the server. Keep in mind
 that messages are sent asynchronously from the server to the clients.
 
 ```php
-$callback = function ($msg) {
+$callback = function (AMQPMessage $msg) {
   echo ' [x] Received ', $msg->body, "\n";
 };
 
diff --git a/tutorials/tutorial-six-php.md b/tutorials/tutorial-six-php.md
@@ -87,7 +87,7 @@ list($queue_name, ,) = $channel->queue_declare("", false, false, true, false);
 
 $msg = new AMQPMessage(
     $payload,
-    array('reply_to' => $queue_name)
+    ['reply_to' => $queue_name]
 );
 
 $channel->basic_publish($msg, '', 'rpc_queue');
@@ -159,14 +159,15 @@ Putting it all together
 The Fibonacci task:
 
 ```php
-function fib($n)
+function fib(int $n)
 {
-    if ($n == 0) {
+    if ($n === 0) {
         return 0;
     }
-    if ($n == 1) {
+    if ($n === 1) {
         return 1;
     }
+
     return fib($n-1) + fib($n-2);
 }
 ```
@@ -189,25 +190,26 @@ $channel = $connection->channel();
 
 $channel->queue_declare('rpc_queue', false, false, false, false);
 
-function fib($n)
+function fib(int $n)
 {
-    if ($n == 0) {
+    if ($n === 0) {
         return 0;
     }
-    if ($n == 1) {
+    if ($n === 1) {
         return 1;
     }
+
     return fib($n-1) + fib($n-2);
 }
 
 echo " [x] Awaiting RPC requests\n";
-$callback = function ($req) {
+$callback = function (AMQPMessage $req) {
     $n = intval($req->getBody());
     echo ' [.] fib(', $n, ")\n";
 
     $msg = new AMQPMessage(
         (string) fib($n),
-        array('correlation_id' => $req->get('correlation_id'))
+        ['correlation_id' => $req->get('correlation_id')]
     );
 
     $req->getChannel()->basic_publish(
@@ -218,7 +220,7 @@ $callback = function ($req) {
     $req->ack();
 };
 
-$channel->basic_qos(null, 1, false);
+$channel->basic_qos(0, 1, false);
 $channel->basic_consume('rpc_queue', '', false, false, false, false, $callback);
 
 try {
@@ -250,12 +252,13 @@ The code for our RPC client [rpc_client.php](https://github.com/rabbitmq/rabbitm
 
 require_once __DIR__ . '/vendor/autoload.php';
 use PhpAmqpLib\Connection\AMQPStreamConnection;
+use PhpAmqpLib\Channel\AMQPChannel;
 use PhpAmqpLib\Message\AMQPMessage;
 
 class FibonacciRpcClient
 {
-    private $connection;
-    private $channel;
+    private AMQPStreamConnection $connection;
+    private AMQPChannel $channel;
     private $callback_queue;
     private $response;
     private $corr_id;
@@ -283,36 +286,37 @@ class FibonacciRpcClient
             true,
             false,
             false,
-            array(
+            [
                 $this,
                 'onResponse'
-            )
+            ]
         );
     }
 
-    public function onResponse($rep)
+    public function onResponse(AMQPMessage $rep)
     {
-        if ($rep->get('correlation_id') == $this->corr_id) {
-            $this->response = $rep->body;
+        if ($rep->get('correlation_id') === $this->corr_id) {
+            $this->response = $rep->body();
         }
     }
 
-    public function call($n)
+    public function call(int $n)
     {
         $this->response = null;
         $this->corr_id = uniqid();
 
         $msg = new AMQPMessage(
             (string) $n,
-            array(
+            [
                 'correlation_id' => $this->corr_id,
-                'reply_to' => $this->callback_queue
-            )
+                'reply_to' => $this->callback_queue,
+            ]
         );
         $this->channel->basic_publish($msg, '', 'rpc_queue');
         while (!$this->response) {
             $this->channel->wait();
         }
+
         return intval($this->response);
     }
 }
diff --git a/tutorials/tutorial-three-php.md b/tutorials/tutorial-three-php.md
@@ -236,6 +236,7 @@ The code for `receive_logs.php`:
 
 require_once __DIR__ . '/vendor/autoload.php';
 use PhpAmqpLib\Connection\AMQPStreamConnection;
+use PhpAmqpLib\Message\AMQPMessage;
 
 $connection = new AMQPStreamConnection('localhost', 5672, 'guest', 'guest');
 $channel = $connection->channel();
@@ -248,7 +249,7 @@ $channel->queue_bind($queue_name, 'logs');
 
 echo " [*] Waiting for logs. To exit press CTRL+C\n";
 
-$callback = function ($msg) {
+$callback = function (AMQPMessage $msg) {
     echo ' [x] ', $msg->getBody(), "\n";
 };
 
diff --git a/tutorials/tutorial-two-php.md b/tutorials/tutorial-two-php.md
@@ -81,7 +81,7 @@ fake a second of work for every dot in the message body. It will pop
 messages from the queue and perform the task, so let's call it `worker.php`:
 
 ```php
-$callback = function ($msg) {
+$callback = function (AMQPMessage $msg) {
   echo ' [x] Received ', $msg->getBody(), "\n";
   sleep(substr_count($msg->getBody(), '.'));
   echo " [x] Done\n";
@@ -92,7 +92,7 @@ $channel->basic_consume('hello', '', false, true, false, false, $callback);
 
 Note that our fake task simulates execution time.
 
-Run them as in tutorial one:
+Run them as in the tutorial one:
 
 ```bash
 # shell 1
@@ -202,7 +202,7 @@ It's time to turn them on by setting the fourth parameter to `basic_consume` to
 from the worker, once we're done with a task.
 
 ```php
-$callback = function ($msg) {
+$callback = function (AMQPMessage $msg) {
   echo ' [x] Received ', $msg->getBody(), "\n";
   sleep(substr_count($msg->getBody(), '.'));
   echo " [x] Done\n";
@@ -281,10 +281,9 @@ even if RabbitMQ restarts. Now we need to mark our messages as persistent
 as part of the property array.
 
 ```php
-$msg = new AMQPMessage(
-    $data,
-    array('delivery_mode' => AMQPMessage::DELIVERY_MODE_PERSISTENT)
-);
+$msg = new AMQPMessage($data, [
+    'delivery_mode' => AMQPMessage::DELIVERY_MODE_PERSISTENT
+]);
 ```
 
 > #### Note on message persistence
@@ -323,7 +322,7 @@ a new message to a worker until it has processed and acknowledged the
 previous one. Instead, it will dispatch it to the next worker that is not still busy.
 
 ```php
-$channel->basic_qos(null, 1, false);
+$channel->basic_qos(0, 1, false);
 ```
 
 > #### Note about queue size
@@ -352,10 +351,9 @@ $data = implode(' ', array_slice($argv, 1));
 if (empty($data)) {
     $data = "Hello World!";
 }
-$msg = new AMQPMessage(
-    $data,
-    array('delivery_mode' => AMQPMessage::DELIVERY_MODE_PERSISTENT)
-);
+$msg = new AMQPMessage($data, [
+    'delivery_mode' => AMQPMessage::DELIVERY_MODE_PERSISTENT,
+]);
 
 $channel->basic_publish($msg, '', 'task_queue');
 
@@ -375,6 +373,7 @@ And our `worker.php`:
 
 require_once __DIR__ . '/vendor/autoload.php';
 use PhpAmqpLib\Connection\AMQPStreamConnection;
+use PhpAmqpLib\Message\AMQPMessage;
 
 $connection = new AMQPStreamConnection('localhost', 5672, 'guest', 'guest');
 $channel = $connection->channel();
@@ -383,7 +382,7 @@ $channel->queue_declare('task_queue', false, true, false, false);
 
 echo " [*] Waiting for messages. To exit press CTRL+C\n";
 
-$callback = function ($msg) {
+$callback = function (AMQPMessage $msg) {
     echo ' [x] Received ', $msg->getBody(), "\n";
     sleep(substr_count($msg->getBody(), '.'));
     echo " [x] Done\n";
