Allow live pdf template edit

composer.json

@@ -13,12 +13,14 @@
         "doctrine/orm": "^2.7",
         "doctrine/persistence": "^1.3 || ^2.2",
         "fakerphp/faker": "^1.9.0",
+        "knplabs/gaufrette": "^0.8",
         "knplabs/knp-menu": "^3.2",
         "knplabs/knp-snappy": "^1.2",
         "knplabs/knp-snappy-bundle": "^1.7",
         "sylius/resource-bundle": "^1.6",
         "symfony/config": "^4.4 || ^5.0",
         "symfony/dependency-injection": "^4.4 || ^5.0",
+        "symfony/dom-crawler": "^4.4 || ^5.0",
         "symfony/event-dispatcher": "^4.4 || ^5.0",
         "symfony/form": "^4.4 || ^5.0",
         "symfony/http-foundation": "^4.4 || ^5.0.7",

src/Controller/Action/Admin/GenerateEncodedExamplePdfAction.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusGiftCardPlugin\Controller\Action\Admin;
+
+use Setono\SyliusGiftCardPlugin\Factory\GiftCardFactoryInterface;
+use Setono\SyliusGiftCardPlugin\Form\Type\GiftCardConfigurationType;
+use Setono\SyliusGiftCardPlugin\Generator\GiftCardPdfGeneratorInterface;
+use Setono\SyliusGiftCardPlugin\Model\GiftCardConfigurationInterface;
+use Sylius\Component\Resource\Repository\RepositoryInterface;
+use Symfony\Component\Form\FormFactoryInterface;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Webmozart\Assert\Assert;
+
+final class GenerateEncodedExamplePdfAction
+{
+    private GiftCardFactoryInterface $giftCardFactory;
+
+    private RepositoryInterface $giftCardConfigurationRepository;
+
+    private GiftCardPdfGeneratorInterface $giftCardPdfGenerator;
+
+    private FormFactoryInterface $formFactory;
+
+    public function __construct(
+        GiftCardFactoryInterface $giftCardFactory,
+        RepositoryInterface $giftCardConfigurationRepository,
+        GiftCardPdfGeneratorInterface $giftCardPdfGenerator,
+        FormFactoryInterface $formFactory
+    ) {
+        $this->giftCardFactory = $giftCardFactory;
+        $this->giftCardConfigurationRepository = $giftCardConfigurationRepository;
+        $this->giftCardPdfGenerator = $giftCardPdfGenerator;
+        $this->formFactory = $formFactory;
+    }
+
+    public function __invoke(Request $request, int $id): Response
+    {
+        $giftCard = $this->giftCardFactory->createExample();
+        /** @var GiftCardConfigurationInterface|null $giftCardConfiguration */
+        $giftCardConfiguration = $this->giftCardConfigurationRepository->find($id);
+        Assert::isInstanceOf($giftCardConfiguration, GiftCardConfigurationInterface::class);
+
+        $form = $this->formFactory->create(GiftCardConfigurationType::class, $giftCardConfiguration);
+        $form->handleRequest($request);
+
+        $pdfContent = $this->giftCardPdfGenerator->generateAndGetContent($giftCard, $giftCardConfiguration);
+
+        return new Response(\base64_encode($pdfContent));
+    }
+}

src/Controller/Action/Admin/LoadDefaultPdfCssAction.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusGiftCardPlugin\Controller\Action\Admin;
+
+use Setono\SyliusGiftCardPlugin\Factory\GiftCardFactoryInterface;
+use Setono\SyliusGiftCardPlugin\Generator\GiftCardPdfGeneratorInterface;
+use Setono\SyliusGiftCardPlugin\Model\GiftCardConfigurationInterface;
+use Setono\SyliusGiftCardPlugin\Provider\DefaultPdfCssProviderInterface;
+use Sylius\Component\Resource\Repository\RepositoryInterface;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Webmozart\Assert\Assert;
+
+final class LoadDefaultPdfCssAction
+{
+    private GiftCardFactoryInterface $giftCardFactory;
+
+    private RepositoryInterface $giftCardConfigurationRepository;
+
+    private GiftCardPdfGeneratorInterface $giftCardPdfGenerator;
+
+    private DefaultPdfCssProviderInterface $defaultPdfCssProvider;
+
+    public function __construct(
+        GiftCardFactoryInterface $giftCardFactory,
+        RepositoryInterface $giftCardConfigurationRepository,
+        GiftCardPdfGeneratorInterface $giftCardPdfGenerator,
+        DefaultPdfCssProviderInterface $defaultPdfCssProvider
+    ) {
+        $this->giftCardFactory = $giftCardFactory;
+        $this->giftCardConfigurationRepository = $giftCardConfigurationRepository;
+        $this->giftCardPdfGenerator = $giftCardPdfGenerator;
+        $this->defaultPdfCssProvider = $defaultPdfCssProvider;
+    }
+
+    public function __invoke(int $id): JsonResponse
+    {
+        $giftCard = $this->giftCardFactory->createExample();
+        /** @var GiftCardConfigurationInterface|null $giftCardConfiguration */
+        $giftCardConfiguration = $this->giftCardConfigurationRepository->find($id);
+        Assert::isInstanceOf($giftCardConfiguration, GiftCardConfigurationInterface::class);
+
+        $defaultCss = $this->defaultPdfCssProvider->getDefaultCss();
+        $giftCardConfiguration->setPdfRenderingCss($defaultCss);
+
+        $pdfContent = $this->giftCardPdfGenerator->generateAndGetContent($giftCard, $giftCardConfiguration);
+
+        return new JsonResponse([
+            'css' => $defaultCss,
+            'pdfContent' => \base64_encode($pdfContent),
+        ]);
+    }
+}

src/DependencyInjection/SetonoSyliusGiftCardExtension.php

@@ -49,6 +49,12 @@ public function load(array $configs, ContainerBuilder $container): void
             $config['pdf_rendering']['available_page_sizes']
         );
 
+        // Load default CSS file
+        $container->setParameter(
+            'setono_sylius_gift_card.default_css_file',
+            '@SetonoSyliusGiftCardPlugin/Shop/GiftCard/defaultGiftCardConfiguration.css.twig'
+        );
+
         $this->registerResources('setono_sylius_gift_card', $config['driver'], $config['resources'], $container);
 
         $loader->load('services.xml');

src/Factory/GiftCardFactory.php

@@ -14,6 +14,7 @@
 use Sylius\Component\Core\Model\ChannelInterface;
 use Sylius\Component\Core\Model\CustomerInterface;
 use Sylius\Component\Core\Model\OrderInterface;
+use Sylius\Component\Currency\Context\CurrencyContextInterface;
 use Sylius\Component\Resource\Factory\FactoryInterface;
 use Webmozart\Assert\Assert;
 
@@ -27,16 +28,20 @@ final class GiftCardFactory implements GiftCardFactoryInterface
 
     private DateTimeProvider $dateTimeProvider;
 
+    private CurrencyContextInterface $currencyContext;
+
     public function __construct(
         FactoryInterface $decoratedFactory,
         GiftCardCodeGeneratorInterface $giftCardCodeGenerator,
         GiftCardChannelConfigurationProviderInterface $giftCardChannelConfigurationProvider,
-        DateTimeProvider $dateTimeProvider
+        DateTimeProvider $dateTimeProvider,
+        CurrencyContextInterface $currencyContext
     ) {
         $this->decoratedFactory = $decoratedFactory;
         $this->giftCardCodeGenerator = $giftCardCodeGenerator;
         $this->giftCardChannelConfigurationProvider = $giftCardChannelConfigurationProvider;
         $this->dateTimeProvider = $dateTimeProvider;
+        $this->currencyContext = $currencyContext;
     }
 
     public function createNew(): GiftCardInterface
@@ -114,4 +119,13 @@ public function createFromOrderItemUnitAndCart(
 
         return $giftCard;
     }
+
+    public function createExample(): GiftCardInterface
+    {
+        $giftCard = $this->createNew();
+        $giftCard->setAmount(1500);
+        $giftCard->setCurrencyCode($this->currencyContext->getCurrencyCode());
+
+        return $giftCard;
+    }
 }

src/Factory/GiftCardFactoryInterface.php

@@ -24,4 +24,9 @@ public function createFromOrderItemUnitAndCart(
         OrderItemUnitInterface $orderItemUnit,
         OrderInterface $cart
     ): GiftCardInterface;
+
+    /**
+     * Create an example GiftCard that is used to generate the example PDF for configuration live rendering
+     */
+    public function createExample(): GiftCardInterface;
 }

src/Form/Type/GiftCardConfigurationType.php

@@ -9,6 +9,7 @@
 use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
 use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
 use Symfony\Component\Form\Extension\Core\Type\CollectionType;
+use Symfony\Component\Form\Extension\Core\Type\TextareaType;
 use Symfony\Component\Form\Extension\Core\Type\TextType;
 use Symfony\Component\Form\FormBuilderInterface;
 
@@ -82,6 +83,9 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                 return $value;
             },
         ]);
+        $builder->add('pdfRenderingCss', TextareaType::class, [
+            'label' => 'setono_sylius_gift_card.form.gift_card_configuration.pdf_rendering_css',
+        ]);
         $builder->get('defaultValidityPeriod')->addModelTransformer(
             new CallbackTransformer(
                 function (?string $period): array {

src/Generator/GiftCardCodeGenerator.php

@@ -31,6 +31,7 @@ public function generate(): string
         do {
             // if we didn't remove the 'hard to read' characters we would only have to
             // generate codeLength / 2 bytes because hex uses two characters to represent one byte
+            /** @psalm-suppress ArgumentTypeCoercion */
             $code = bin2hex(random_bytes($this->codeLength));
             $code = preg_replace('/[01]/', '', $code); // remove hard to read characters
             $code = mb_strtoupper(mb_substr($code, 0, $this->codeLength));

src/Generator/GiftCardPdfGenerator.php

@@ -4,6 +4,7 @@
 
 namespace Setono\SyliusGiftCardPlugin\Generator;
 
+use Gaufrette\FilesystemInterface;
 use Knp\Bundle\SnappyBundle\Snappy\Response\PdfResponse;
 use Knp\Snappy\GeneratorInterface;
 use Setono\SyliusGiftCardPlugin\Model\GiftCardConfigurationInterface;
@@ -19,14 +20,22 @@ class GiftCardPdfGenerator implements GiftCardPdfGeneratorInterface
 
     private PdfRenderingOptionsProviderInterface $renderingOptionsProvider;
 
+    private GiftCardPdfPathGeneratorInterface $giftCardPdfPathGenerator;
+
+    private FilesystemInterface $filesystem;
+
     public function __construct(
         Environment $twig,
         GeneratorInterface $snappy,
-        PdfRenderingOptionsProviderInterface $renderingOptionsProvider
+        PdfRenderingOptionsProviderInterface $renderingOptionsProvider,
+        GiftCardPdfPathGeneratorInterface $giftCardPdfPathGenerator,
+        FilesystemInterface $filesystem
     ) {
         $this->twig = $twig;
         $this->snappy = $snappy;
         $this->renderingOptionsProvider = $renderingOptionsProvider;
+        $this->giftCardPdfPathGenerator = $giftCardPdfPathGenerator;
+        $this->filesystem = $filesystem;
     }
 
     public function generatePdfResponse(
@@ -42,4 +51,39 @@ public function generatePdfResponse(
 
         return new PdfResponse($this->snappy->getOutputFromHtml($html, $renderingOptions), 'gift_card.pdf');
     }
+
+    public function generateAndGetContent(
+        GiftCardInterface $giftCard,
+        GiftCardConfigurationInterface $giftCardChannelConfiguration
+    ): string {
+        $html = $this->twig->render('@SetonoSyliusGiftCardPlugin/Shop/GiftCard/pdf.html.twig', [
+            'giftCard' => $giftCard,
+            'configuration' => $giftCardChannelConfiguration,
+        ]);
+        $renderingOptions = $this->renderingOptionsProvider->getRenderingOptions($giftCardChannelConfiguration);
+
+        return $this->snappy->getOutputFromHtml($html, $renderingOptions);
+    }
+
+    public function generateAndSavePdf(
+        GiftCardInterface $giftCard,
+        GiftCardConfigurationInterface $giftCardChannelConfiguration
+    ): string {
+        $html = $this->twig->render('@SetonoSyliusGiftCardPlugin/Shop/GiftCard/pdf.html.twig', [
+            'giftCard' => $giftCard,
+            'configuration' => $giftCardChannelConfiguration,
+        ]);
+        $renderingOptions = $this->renderingOptionsProvider->getRenderingOptions($giftCardChannelConfiguration);
+
+        $filePath = $this->giftCardPdfPathGenerator->generatePath($giftCardChannelConfiguration);
+        $pdfContent = $this->snappy->getOutputFromHtml($html, $renderingOptions);
+
+        $this->filesystem->write(
+            $filePath,
+            $pdfContent,
+            true
+        );
+
+        return $filePath;
+    }
 }

src/Generator/GiftCardPdfGeneratorInterface.php

@@ -14,4 +14,14 @@ public function generatePdfResponse(
         GiftCardInterface $giftCard,
         GiftCardConfigurationInterface $giftCardChannelConfiguration
     ): PdfResponse;
+
+    public function generateAndGetContent(
+        GiftCardInterface $giftCard,
+        GiftCardConfigurationInterface $giftCardChannelConfiguration
+    ): string;
+
+    public function generateAndSavePdf(
+        GiftCardInterface $giftCard,
+        GiftCardConfigurationInterface $giftCardChannelConfiguration
+    ): string;
 }

src/Generator/GiftCardPdfPathGenerator.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusGiftCardPlugin\Generator;
+
+use Setono\SyliusGiftCardPlugin\Model\GiftCardConfigurationInterface;
+use function sprintf;
+use Webmozart\Assert\Assert;
+
+final class GiftCardPdfPathGenerator implements GiftCardPdfPathGeneratorInterface
+{
+    public function generatePath(GiftCardConfigurationInterface $giftCardChannelConfiguration): string
+    {
+        $giftCardChannelConfigurationId = $giftCardChannelConfiguration->getId();
+        Assert::integer($giftCardChannelConfigurationId);
+
+        return sprintf(
+            'gift_card_configuration_pdf_%d.pdf',
+            $giftCardChannelConfigurationId
+        );
+    }
+}

src/Generator/GiftCardPdfPathGeneratorInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusGiftCardPlugin\Generator;
+
+use Setono\SyliusGiftCardPlugin\Model\GiftCardConfigurationInterface;
+
+interface GiftCardPdfPathGeneratorInterface
+{
+    public function generatePath(GiftCardConfigurationInterface $giftCardChannelConfiguration): string;
+}

src/Model/GiftCardConfiguration.php

@@ -42,6 +42,8 @@ class GiftCardConfiguration implements GiftCardConfigurationInterface
 
     protected ?string $orientation = null;
 
+    protected ?string $pdfRenderingCss = null;
+
     public function __construct()
     {
         $this->images = new ArrayCollection();
@@ -201,4 +203,14 @@ public function setOrientation(?string $orientation): void
     {
         $this->orientation = $orientation;
     }
+
+    public function getPdfRenderingCss(): ?string
+    {
+        return $this->pdfRenderingCss;
+    }
+
+    public function setPdfRenderingCss(?string $pdfRenderingCss): void
+    {
+        $this->pdfRenderingCss = $pdfRenderingCss;
+    }
 }

src/Model/GiftCardConfigurationInterface.php

@@ -50,4 +50,8 @@ public function setPageSize(?string $pageSize): void;
     public function getOrientation(): ?string;
 
     public function setOrientation(?string $orientation): void;
+
+    public function getPdfRenderingCss(): ?string;
+
+    public function setPdfRenderingCss(?string $pdfRenderingCss): void;
 }

src/Provider/DefaultPdfCssProvider.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusGiftCardPlugin\Provider;
+
+use Twig\Environment;
+
+final class DefaultPdfCssProvider implements DefaultPdfCssProviderInterface
+{
+    private string $defaultCssFile;
+
+    private Environment $twig;
+
+    public function __construct(string $defaultCssFile, Environment $twig)
+    {
+        $this->defaultCssFile = $defaultCssFile;
+        $this->twig = $twig;
+    }
+
+    public function getDefaultCss(): string
+    {
+        return $this->twig->render($this->defaultCssFile);
+    }
+}