Merge pull request #10 from delyriand/feature/use-new-email-manager-service

Use correct email manager serverivce for Sylius > 1.13, and add messages for constraints and prefill name

Author: Maxime

.github/workflows/recipe.yaml

@@ -15,7 +15,7 @@ jobs:
       fail-fast: false
       matrix:
         php: ['8.1', '8.2', '8.3']
-        sylius: ["~1.12.0", "~1.13.0", "1.14.0"]
+        sylius: ["~1.13.0", "1.14.0"]
 
     steps:
       - name: Setup PHP

README.md

@@ -16,7 +16,6 @@ This plugin allows you to customize the contact page on the front-end of your Sy
 
 | Sylius Version | PHP Version     |
 |----------------|-----------------|
-| 1.12           | 8.1 - 8.2 - 8.3 |
 | 1.13           | 8.1 - 8.2 - 8.3 |
 | 1.14           | 8.1 - 8.2 - 8.3 |
 

composer.json

@@ -6,7 +6,7 @@
     "license": "MIT",
     "require": {
         "php": "^8.1",
-        "sylius/sylius": ">=1.12 <2.0",
+        "sylius/sylius": ">=1.13 <2.0",
         "monsieurbiz/sylius-settings-plugin": "^1.2.0",
         "monsieurbiz/sylius-rich-editor-plugin": "^2.8.0"
     },

src/EmailManager/DecorateContactEmailManager.php

@@ -16,17 +16,27 @@
 use Doctrine\ORM\EntityManagerInterface;
 use MonsieurBiz\SyliusContactRequestPlugin\Factory\ContactRequestFactoryInterface;
 use MonsieurBiz\SyliusSettingsPlugin\Provider\SettingsProviderInterface;
-use Sylius\Bundle\ShopBundle\EmailManager\ContactEmailManagerInterface;
+use Sylius\Bundle\CoreBundle\Mailer\ContactEmailManagerInterface;
+use Sylius\Bundle\ShopBundle\EmailManager\ContactEmailManagerInterface as OldContactEmailManagerInterface;
 use Sylius\Component\Core\Model\ChannelInterface;
 
 final class DecorateContactEmailManager implements ContactEmailManagerInterface
 {
     public function __construct(
-        private ContactEmailManagerInterface $decoratedContactEmailManager,
+        private OldContactEmailManagerInterface|ContactEmailManagerInterface $decoratedContactEmailManager,
         private ContactRequestFactoryInterface $contactRequestFactory,
         private EntityManagerInterface $contactRequestManager,
         private SettingsProviderInterface $settingProvider,
     ) {
+        if ($this->decoratedContactEmailManager instanceof OldContactEmailManagerInterface) {
+            trigger_deprecation(
+                'sylius/shop-bundle',
+                '1.13',
+                'The "%s" interface is deprecated, use "%s" instead.',
+                OldContactEmailManagerInterface::class,
+                ContactEmailManagerInterface::class,
+            );
+        }
     }
 
     public function sendContactRequest(array $data, array $recipients, ChannelInterface $channel = null, string $localeCode = null): void

src/Form/Extension/ContactTypeExtension.php

@@ -15,17 +15,21 @@
 
 use MonsieurBiz\SyliusSettingsPlugin\Provider\SettingsProviderInterface;
 use Sylius\Bundle\CoreBundle\Form\Type\ContactType;
+use Sylius\Component\Customer\Context\CustomerContextInterface;
 use Symfony\Component\Form\AbstractTypeExtension;
 use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
 use Symfony\Component\Form\Extension\Core\Type\TelType;
 use Symfony\Component\Form\Extension\Core\Type\TextType;
 use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\Form\FormEvent;
+use Symfony\Component\Form\FormEvents;
 use Symfony\Component\Validator\Constraints as Assert;
 
 final class ContactTypeExtension extends AbstractTypeExtension
 {
     public function __construct(
         private SettingsProviderInterface $settingProvider,
+        private CustomerContextInterface $customerContext,
     ) {
     }
 
@@ -36,15 +40,6 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
     {
         parent::buildForm($builder, $options);
 
-        $defaultConstraints = [
-            new Assert\Length(['max' => 255]),
-        ];
-
-        $requiredConstraints = [
-            new Assert\NotBlank(),
-            new Assert\Length(['max' => 255]),
-        ];
-
         $isNameRequired = $this->isFieldRequired('field_name_required', 'field_name_displayed');
         $isCompanyRequired = $this->isFieldRequired('field_company_required', 'field_company_displayed');
         $isPhoneNumberRequired = $this->isFieldRequired('field_phone_number_required', 'field_phone_number_displayed');
@@ -53,17 +48,18 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
             ->add('name', TextType::class, [
                 'label' => 'monsieurbiz.contact_request.form.name',
                 'required' => $isNameRequired,
-                'constraints' => $isNameRequired ? $requiredConstraints : $defaultConstraints,
+                'constraints' => $this->getConstraints($isNameRequired, 'monsieurbiz.contact_request.name.not_blank'),
             ])
             ->add('company', TextType::class, [
                 'label' => 'monsieurbiz.contact_request.form.company',
                 'required' => $isCompanyRequired,
-                'constraints' => $isCompanyRequired ? $requiredConstraints : $defaultConstraints,
+                'constraints' => $this->getConstraints($isCompanyRequired, 'monsieurbiz.contact_request.company.not_blank'),
             ])
             ->add('phoneNumber', TelType::class, [
                 'label' => 'monsieurbiz.contact_request.form.phone_number',
+                'invalid_message' => 'monsieurbiz.contact_request.phone_number.invalid',
                 'required' => $isPhoneNumberRequired,
-                'constraints' => $isPhoneNumberRequired ? $requiredConstraints : $defaultConstraints,
+                'constraints' => $this->getConstraints($isPhoneNumberRequired, 'monsieurbiz.contact_request.phone_number.not_blank'),
             ])
         ;
 
@@ -82,6 +78,19 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                 ],
             ]);
         }
+
+        $builder->addEventListener(FormEvents::PRE_SET_DATA, function (FormEvent $event): void {
+            $name = $this->customerContext->getCustomer()?->getFullName();
+            if (null === $name) {
+                return;
+            }
+
+            /** @var array $data */
+            $data = $event->getData();
+            $data['name'] = $name;
+
+            $event->setData($data);
+        });
     }
 
     public static function getExtendedTypes(): iterable
@@ -96,4 +105,16 @@ private function isFieldRequired(string $path, string $pathDisplayed): bool
         return $this->settingProvider->getSettingValue('monsieurbiz_contact_request.contact', $path)
             && $this->settingProvider->getSettingValue('monsieurbiz_contact_request.contact', $pathDisplayed);
     }
+
+    private function getConstraints(bool $isRequired, ?string $blankMessage): array
+    {
+        return $isRequired ? [
+            new Assert\NotBlank([
+                'message' => $blankMessage,
+            ]),
+            new Assert\Length(['max' => 255]),
+        ] : [
+            new Assert\Length(['max' => 255]),
+        ];
+    }
 }

src/Resources/config/services.yaml

@@ -10,7 +10,7 @@ services:
 
     # Save contact request entity
     MonsieurBiz\SyliusContactRequestPlugin\EmailManager\DecorateContactEmailManager:
-        decorates: 'sylius.email_manager.contact'
+        decorates: 'sylius.mailer.contact_email_manager.shop'
         arguments: [ '@.inner' ]
 
     # Add admin menu

src/Resources/translations/validators.en.yaml

@@ -1,3 +1,10 @@
 monsieurbiz:
     contact_request:
         confirmation_error: 'You need to approve this field'
+        name:
+            not_blank: Please enter your name
+        company:
+            not_blank: Please enter your company name
+        phone_number:
+            invalid: Please enter a valid phone number
+            not_blank: Please enter your phone number

src/Resources/translations/validators.fr.yaml

@@ -1,3 +1,10 @@
 monsieurbiz:
     contact_request:
         confirmation_error: 'Vous devez approuver ce champ'
+        name:
+            not_blank: Veuillez entrer votre nom
+        company:
+            not_blank: Veuillez entrer le nom de votre société
+        phone_number:
+            invalid: Veuillez entrer un numéro de téléphone valide
+            not_blank: Veuillez entrer votre numéro de téléphone