Invoice path relative to invoices_root_dir. Added invoice naming method.

.gitignore

@@ -9,3 +9,4 @@
 !/etc/build/.gitkeep
 
 /tests/Application/yarn.lock
+/.idea

README.md

@@ -100,6 +100,7 @@ theme path, in case you are using multiple themes.
   bitbag_sylius_invoicing_plugin.event_listener.order_show                                     BitBag\SyliusInvoicingPlugin\Menu\DownloadInvoiceMenuBuilder                                              
   bitbag_sylius_invoicing_plugin.factory.company_data                                          Sylius\Component\Resource\Factory\Factory                                                                 
   bitbag_sylius_invoicing_plugin.factory.invoice                                               Sylius\Component\Resource\Factory\Factory                                                                 
+  bitbag_sylius_invoicing_plugin.file_generator.invoice_filename                               BitBag\SyliusInvoicingPlugin\FileGenerator\InvoicePdfFilenameGenerator                                        
   bitbag_sylius_invoicing_plugin.file_generator.invoice_file                                   BitBag\SyliusInvoicingPlugin\FileGenerator\InvoicePdfFileGenerator                                        
   bitbag_sylius_invoicing_plugin.form.extension.address                                        BitBag\SyliusInvoicingPlugin\Form\Extension\AddressTypeExtension                                          
   bitbag_sylius_invoicing_plugin.form.type.company_data                                        BitBag\SyliusInvoicingPlugin\Form\Type\CompanyDataType                                                    

src/FileGenerator/FileGeneratorInterface.php

@@ -26,5 +26,5 @@ public function generateFile(InvoiceInterface $invoice): string;
     /**
      * @return string
      */
-    public function getFilesPath(): string;
+    public function getFilesDirectoryPath(): string;
 }

src/FileGenerator/FilenameGeneratorInterface.php

@@ -0,0 +1,25 @@
+<?php
+
+/*
+ * This file has been created by developers from BitBag.
+ * Feel free to contact us once you face any issues or want to start
+ * another great project.
+ * You can find more information about us on https://bitbag.shop and write us
+ * an email on mikolaj.krol@bitbag.pl.
+ */
+
+declare(strict_types=1);
+
+namespace BitBag\SyliusInvoicingPlugin\FileGenerator;
+
+use BitBag\SyliusInvoicingPlugin\Entity\InvoiceInterface;
+
+interface FilenameGeneratorInterface
+{
+    /**
+     * @param InvoiceInterface $invoice
+     *
+     * @return string
+     */
+    public function generateFilename(InvoiceInterface $invoice): string;
+}

src/FileGenerator/InvoicePdfFileGenerator.php

@@ -19,6 +19,11 @@
 
 final class InvoicePdfFileGenerator implements FileGeneratorInterface
 {
+    /**
+     * @var FilenameGeneratorInterface
+     */
+    protected $filenameGenerator;
+
     /**
      * @var GeneratorInterface
      */
@@ -44,17 +49,20 @@ final class InvoicePdfFileGenerator implements FileGeneratorInterface
      * @param EngineInterface $templatingEngine
      * @param CompanyDataResolverInterface $companyDataResolver
      * @param string $filesPath
+     * @param FilenameGeneratorInterface $filenameGenerator
      */
     public function __construct(
         GeneratorInterface $pdfFileGenerator,
         EngineInterface $templatingEngine,
         CompanyDataResolverInterface $companyDataResolver,
-        string $filesPath
+        string $filesPath,
+        FilenameGeneratorInterface $filenameGenerator
     ) {
         $this->pdfFileGenerator = $pdfFileGenerator;
         $this->templatingEngine = $templatingEngine;
         $this->companyDataResolver = $companyDataResolver;
         $this->filesPath = $filesPath;
+        $this->filenameGenerator = $filenameGenerator;
     }
 
     /**
@@ -68,33 +76,18 @@ public function generateFile(InvoiceInterface $invoice): string
                 'companyData' => $this->companyDataResolver->resolveCompanyData(),
             ]
         );
-        $filename = $this->getInvoiceFilename($invoice);
+        $filename = $this->filenameGenerator->generateFilename($invoice);
         $path = $this->filesPath . DIRECTORY_SEPARATOR . $filename;
 
         $this->pdfFileGenerator->generateFromHtml($html, $path);
 
         return $filename;
     }
 
-    /**
-     * @param InvoiceInterface $invoice
-     * @return string Returns an explicit invoice file name
-     */
-    protected function getInvoiceFilename(InvoiceInterface $invoice): string
-    {
-        $tokens = [
-            $invoice->getOrder()->getNumber(),
-            $invoice->getOrder()->getCreatedAt()->format('Ymd'),
-            bin2hex(random_bytes(6)),
-        ];
-
-        return (string) implode('_', $tokens) . '.pdf';
-    }
-
     /**
      * {@inheritdoc}
      */
-    public function getFilesPath(): string
+    public function getFilesDirectoryPath(): string
     {
         return $this->filesPath;
     }

src/FileGenerator/InvoicePdfFilenameGenerator.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file has been created by developers from BitBag.
+ * Feel free to contact us once you face any issues or want to start
+ * another great project.
+ * You can find more information about us on https://bitbag.shop and write us
+ * an email on mikolaj.krol@bitbag.pl.
+ */
+
+declare(strict_types=1);
+
+namespace BitBag\SyliusInvoicingPlugin\FileGenerator;
+
+use BitBag\SyliusInvoicingPlugin\Entity\InvoiceInterface;
+
+final class InvoicePdfFilenameGenerator implements FilenameGeneratorInterface
+{
+    /**
+     * @inheritDoc
+     */
+    public function generateFilename(InvoiceInterface $invoice): string
+    {
+        $tokens = [
+            $invoice->getOrder()->getNumber(),
+            $invoice->getOrder()->getCreatedAt()->format('Ymd'),
+            bin2hex(random_bytes(6)),
+        ];
+
+        return (string) implode('_', $tokens) . '.pdf';
+    }
+}

src/Resolver/InvoiceFileResolver.php

@@ -69,6 +69,6 @@ public function resolveInvoicePath(InvoiceInterface $invoice): string
             $this->invoiceEntityManager->flush();
         }
 
-        return $this->invoiceFileGenerator->getFilesPath() . DIRECTORY_SEPARATOR . $invoice->getPath();
+        return $this->invoiceFileGenerator->getFilesDirectoryPath() . DIRECTORY_SEPARATOR . $invoice->getPath();
     }
 }

src/Resources/config/services.yml

@@ -5,13 +5,17 @@ imports:
     - { resource: "@BitBagSyliusInvoicingPlugin/Resources/config/services/resolver.yml" }
 
 services:
+    bitbag_sylius_invoicing_plugin.file_generator.invoice_filename:
+        class: BitBag\SyliusInvoicingPlugin\FileGenerator\InvoicePdfFilenameGenerator
+
     bitbag_sylius_invoicing_plugin.file_generator.invoice_file:
         class: BitBag\SyliusInvoicingPlugin\FileGenerator\InvoicePdfFileGenerator
         arguments:
             - "@knp_snappy.pdf"
             - "@templating"
             - "@bitbag_sylius_invoicing_plugin.resolver.company_data"
             - "%invoices_root_dir%"
+            - "@bitbag_sylius_invoicing_plugin.file_generator.invoice_filename"
 
     bitbag_sylius_invoicing_plugin.validator.vat_number:
         class: BitBag\SyliusInvoicingPlugin\Validator\Constraints\VatNumberValidator