Add support for invoice modifiers in InvoiceCreator

Author: tomkalon

config/services/generators.xml

@@ -60,6 +60,7 @@
             <argument type="service" id="sylius_invoicing.generator.invoice_pdf_file" />
             <argument type="service" id="sylius_invoicing.manager.invoice_file" />
             <argument>%sylius_invoicing.pdf_generator.enabled%</argument>
+            <argument type="tagged_iterator" tag="sylius_invoicing.modifier.invoice" />
         </service>
         <service id="Sylius\InvoicingPlugin\Creator\InvoiceCreatorInterface" alias="sylius_invoicing.creator.invoice" />
 

src/Creator/InvoiceCreator.php

@@ -22,6 +22,7 @@
 use Sylius\InvoicingPlugin\Generator\InvoiceGeneratorInterface;
 use Sylius\InvoicingPlugin\Generator\InvoicePdfFileGeneratorInterface;
 use Sylius\InvoicingPlugin\Manager\InvoiceFileManagerInterface;
+use Sylius\InvoicingPlugin\Modifier\InvoiceModifierInterface;
 
 final class InvoiceCreator implements InvoiceCreatorInterface
 {
@@ -32,7 +33,17 @@ public function __construct(
         private readonly InvoicePdfFileGeneratorInterface $invoicePdfFileGenerator,
         private readonly InvoiceFileManagerInterface $invoiceFileManager,
         private readonly bool $hasEnabledPdfFileGenerator = true,
+        private readonly ?iterable $invoiceModifiers = null,
     ) {
+        if (null === $this->invoiceModifiers) {
+            trigger_deprecation(
+                'sylius/invoicing-plugin',
+                '2.1',
+                'Not passing a "%s" to "%s" is deprecated and will be required in Sylius Invoicing Plugin 3.0.',
+                InvoiceModifierInterface::class,
+                self::class,
+            );
+        }
     }
 
     public function __invoke(string $orderNumber, \DateTimeInterface $dateTime): void
@@ -49,6 +60,12 @@ public function __invoke(string $orderNumber, \DateTimeInterface $dateTime): voi
 
         $invoice = $this->invoiceGenerator->generateForOrder($order, $dateTime);
 
+        if (null !== $this->invoiceModifiers) {
+            foreach ($this->invoiceModifiers as $modifier) {
+                $invoice = $modifier->modify($invoice, $order);
+            }
+        }
+
         if (!$this->hasEnabledPdfFileGenerator) {
             $this->invoiceRepository->add($invoice);
 

src/Modifier/InvoiceModifierInterface.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\InvoicingPlugin\Modifier;
+
+use Sylius\Component\Core\Model\OrderInterface;
+use Sylius\InvoicingPlugin\Entity\InvoiceInterface;
+
+interface InvoiceModifierInterface
+{
+    public function modify(InvoiceInterface $invoice, OrderInterface $order): InvoiceInterface;
+}