feat: allow order and payment status to be modified for report

Author: Maxime Leclercq

README.md

@@ -54,6 +54,18 @@ monsieurbiz_sales_reports_plugin:
 
 All reports columns are sortable by clicking on it.
 
+If you want to change order or payments states used in the reports, you can configure it in the `config/packages/monsieurbiz_sylius_sales_reports_plugin.yaml` file:
+
+```yaml
+parameters:
+    monsieurbiz.sales_reports.order_states:
+        - …
+    monsieurbiz.sales_reports.payment_states:
+        - …
+```
+
+(FYI, is it possible to use `!php/const` to use constants in the config file)
+
 ### Global sales report
 
 ![Global sales report](screenshots/global.png)

src/Repository/AbstractReportRepository.php

@@ -76,7 +76,9 @@ abstract class AbstractReportRepository
      */
     public function __construct(
         OrderRepositoryInterface $orderRepository,
-        ProductVariantRepositoryInterface $productVariantRepository
+        ProductVariantRepositoryInterface $productVariantRepository,
+        protected ?array $orderStates,
+        protected ?array $paymentStates,
     ) {
         $this->orderRepository = $orderRepository;
         $this->productVariantRepository = $productVariantRepository;
@@ -186,6 +188,8 @@ protected function appendAdjustmentsAndParameters(
         bool $isOrder = false
     ) {
         $elementAlias = $isOrder ? 'o' : 'element';
+        $orderStates = $this->orderStates ?? [OrderInterface::STATE_FULFILLED, OrderInterface::STATE_NEW];
+        $paymentStates = $this->paymentStates ?? [OrderPaymentStates::STATE_PAID];
 
         return $queryBuilder
             // Adjustments joins
@@ -237,8 +241,8 @@ protected function appendAdjustmentsAndParameters(
             ->andWhere('o.checkoutCompletedAt BETWEEN :from AND :to')
             // Filters parameters
             ->setParameter('channel', $channel)
-            ->setParameter('states', [OrderInterface::STATE_FULFILLED, OrderInterface::STATE_NEW])
-            ->setParameter('payment_states', [OrderPaymentStates::STATE_PAID]) // @TODO Take care of OrderPaymentStates::STATE_PARTIALLY_PAID
+            ->setParameter('states', $orderStates)
+            ->setParameter('payment_states', $paymentStates)
             ->setParameter('from', $fromDate)
             ->setParameter('to', $toDate)
         ;

src/Resources/config/services.yaml

@@ -1,3 +1,10 @@
+parameters:
+    monsieurbiz.sales_reports.order_states:
+        - !php/const Sylius\Component\Order\Model\OrderInterface::STATE_FULFILLED
+        - !php/const Sylius\Component\Order\Model\OrderInterface::STATE_NEW
+    monsieurbiz.sales_reports.payment_states:
+        - !php/const Sylius\Component\Core\OrderPaymentStates::STATE_PAID
+
 services:
   # Default configuration for services in *this* file
   _defaults:
@@ -26,3 +33,8 @@ services:
     class: MonsieurBiz\SyliusSalesReportsPlugin\Menu\AdminMenuListener
     tags:
       - { name: kernel.event_listener, event: sylius.menu.admin.main, method: addAdminMenuItem }
+
+  MonsieurBiz\SyliusSalesReportsPlugin\Repository\ReportRepository:
+    arguments:
+        $orderStates: '%monsieurbiz.sales_reports.order_states%'
+        $paymentStates: '%monsieurbiz.sales_reports.payment_states%'