From 59e51ac4d768c92c0f4ffed1e7e2a422b4a4ef60 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Muhammet=20=C5=9EAFAK?= <info@muhammetsafak.com.tr>
Date: Sat, 31 Aug 2024 20:09:08 +0300
Subject: [PATCH] readme.md updated

---
 App/Commands/Mail/MailConsumer.php            | 33 -------------------
 ...SConsumer.php => NotificationConsumer.php} | 13 ++++----
 .../{Payments => }/PaymentConsumer.php        |  2 +-
 App/Messages/PaymentMessage.php               | 22 +++++++++++++
 README.md                                     | 10 ++++++
 5 files changed, 40 insertions(+), 40 deletions(-)
 delete mode 100644 App/Commands/Mail/MailConsumer.php
 rename App/Commands/{SMS/SMSConsumer.php => NotificationConsumer.php} (66%)
 rename App/Commands/{Payments => }/PaymentConsumer.php (97%)
 create mode 100644 App/Messages/PaymentMessage.php

diff --git a/App/Commands/Mail/MailConsumer.php b/App/Commands/Mail/MailConsumer.php
deleted file mode 100644
index 1bec050..0000000
--- a/App/Commands/Mail/MailConsumer.php
+++ /dev/null
@@ -1,33 +0,0 @@
-<?php
-namespace App\Commands\Mail;
-
-use App\Queues\NotificationQueue;
-use PHPQueueManager\PHPQueueManager\Queue\MessageInterface;
-use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Input\InputInterface;
-use Symfony\Component\Console\Output\OutputInterface;
-
-class MailConsumer extends Command
-{
-
-    protected static $defaultName = "consume:mail";
-
-    public function execute(InputInterface $input, OutputInterface $output): int
-    {
-        $queue = new NotificationQueue();
-
-        $queue->consume(function (MessageInterface $message) {
-            // The workers that will work for NotificationQueue are defined in Message.
-
-            return true;
-        });
-
-        return Command::SUCCESS;
-    }
-
-    public function configure(): void
-    {
-        $this->setDescription("Sends the emails in the queue.");
-    }
-
-}
diff --git a/App/Commands/SMS/SMSConsumer.php b/App/Commands/NotificationConsumer.php
similarity index 66%
rename from App/Commands/SMS/SMSConsumer.php
rename to App/Commands/NotificationConsumer.php
index 31bcbdc..8cfc169 100644
--- a/App/Commands/SMS/SMSConsumer.php
+++ b/App/Commands/NotificationConsumer.php
@@ -1,15 +1,15 @@
 <?php
-namespace App\Commands\SMS;
+namespace App\Commands;
 use App\Queues\NotificationQueue;
 use PHPQueueManager\PHPQueueManager\Queue\MessageInterface;
-use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Input\InputInterface;
-use Symfony\Component\Console\Output\OutputInterface;
+use \Symfony\Component\Console\Input\InputInterface;
+use \Symfony\Component\Console\Output\OutputInterface;
+use \Symfony\Component\Console\Command\Command;
 
-class SMSConsumer extends Command
+class NotificationConsumer extends Command
 {
 
-    protected static $defaultName = "consume:sms";
+    protected static $defaultName = "consume:notification";
 
     public function execute(InputInterface $input, OutputInterface $output): int
     {
@@ -20,6 +20,7 @@ public function execute(InputInterface $input, OutputInterface $output): int
 
             return true;
         });
+
         return Command::SUCCESS;
     }
 
diff --git a/App/Commands/Payments/PaymentConsumer.php b/App/Commands/PaymentConsumer.php
similarity index 97%
rename from App/Commands/Payments/PaymentConsumer.php
rename to App/Commands/PaymentConsumer.php
index 7f5d7b9..4656657 100644
--- a/App/Commands/Payments/PaymentConsumer.php
+++ b/App/Commands/PaymentConsumer.php
@@ -1,5 +1,5 @@
 <?php
-namespace App\Commands\Payments;
+namespace App\Commands;
 use App\Queues\PaymentQueue;
 use PHPQueueManager\PHPQueueManager\Queue\MessageInterface;
 use Symfony\Component\Console\Command\Command;
diff --git a/App/Messages/PaymentMessage.php b/App/Messages/PaymentMessage.php
new file mode 100644
index 0000000..b3a45e6
--- /dev/null
+++ b/App/Messages/PaymentMessage.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace App\Messages;
+
+use PHPQueueManager\PHPQueueManager\Queue\Message;
+
+class PaymentMessage extends Message
+{
+
+    public function retryNotification(): bool
+    {
+        // It failed and will be retried.
+        return true;
+    }
+
+    public function deadLetterNotification(): bool
+    {
+        // It failed and the message was written as an dead letter.
+        return true;
+    }
+
+}
diff --git a/README.md b/README.md
index bc4d819..de0ed74 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,16 @@ This application was created to easily create and manage your own job queues. Th
 ```
 composer create-project phpqueuemanager/application
 ```
+
+## Why should I use it?
+
+- This application provides tremendous flexibility in scaling.
+- It can work with different queue mechanisms and different connections at the same time.
+- There can be different workers and consumers processing a single queue.
+- Advanced error and data management support.
+
+## Starting
+
 Check out the sample template under the "App" directory before you start developing! And then when you are ready to develop your own app you can execute the following command to **destroy everything in the "App" directory**.
 
 ```