Add some readme

Author: loevgaard

README.md

@@ -25,9 +25,9 @@ in the `config/bundles.php` file of your project before (!) `SyliusGridBundle` a
 return [
     Setono\SyliusRestockNotificationPlugin\SetonoSyliusRestockNotificationPlugin::class => ['all' => true],
     Symfony\Bundle\FrameworkBundle\FrameworkBundle::class => ['all' => true],
-    
+
     // ...
-    
+
     Sylius\Bundle\GridBundle\SyliusGridBundle::class => ['all' => true],
 ];
 ```
@@ -48,6 +48,28 @@ php bin/console doctrine:migrations:diff
 php bin/console doctrine:migrations:migrate
 ```
 
+## Maintenance
+
+### Pruning Old Notification Requests
+
+The plugin includes a command to remove old restock notification requests that are no longer needed. By default, it removes requests that are older than 90 days.
+
+```bash
+# Using the default threshold (90 days)
+php bin/console setono:sylius-restock-notification:prune-requests
+
+# Specifying a custom threshold (e.g., 30 days)
+php bin/console setono:sylius-restock-notification:prune-requests --pruning-threshold=30
+```
+
+You can configure the default threshold in your application's configuration:
+
+```yaml
+# config/packages/setono_sylius_restock_notification.yaml
+setono_sylius_restock_notification:
+    pruning_threshold: 60 # Set the threshold to 60 days
+```
+
 [ico-version]: https://poser.pugx.org/setono/sylius-restock-notification-plugin/v/stable
 [ico-license]: https://poser.pugx.org/setono/sylius-restock-notification-plugin/license
 [ico-github-actions]: https://github.com/Setono/SyliusRestockNotificationPlugin/workflows/build/badge.svg

src/Command/PruneRestockNotificationRequestsCommand.php

@@ -18,29 +18,21 @@ final class PruneRestockNotificationRequestsCommand extends Command
 
     protected static $defaultDescription = 'Remove restock notification requests older than the configured threshold';
 
-    private RestockNotificationRequestRepositoryInterface $restockNotificationRequestRepository;
-
-    private int $pruningThreshold;
-
     public function __construct(
-        RestockNotificationRequestRepositoryInterface $restockNotificationRequestRepository,
-        int $pruningThreshold,
+        private readonly RestockNotificationRequestRepositoryInterface $restockNotificationRequestRepository,
+        private readonly int $pruningThreshold,
     ) {
         parent::__construct();
-
-        $this->restockNotificationRequestRepository = $restockNotificationRequestRepository;
-        $this->pruningThreshold = $pruningThreshold;
     }
 
     protected function configure(): void
     {
         $this
             ->addOption(
-                'threshold-days',
-                't',
+                'pruning-threshold',
+                null,
                 InputOption::VALUE_REQUIRED,
                 'Override the configured threshold (in days)',
-                null,
             )
         ;
     }
@@ -49,8 +41,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
 
-        $thresholdDays = (int) ($input->getOption('threshold-days') ?? $this->pruningThreshold);
-        $date = new DateTimeImmutable(sprintf('-%d days', $thresholdDays));
+        $pruningThreshold = (int) ($input->getOption('pruning-threshold') ?? $this->pruningThreshold);
+        $date = new DateTimeImmutable(sprintf('-%d days', $pruningThreshold));
 
         $count = $this->restockNotificationRequestRepository->removeOlderThan($date);