Merge pull request #2 from Sylius/fix-province-on-checkout

Add and document ProvinceController polyfill

Author: Wojdylak

README.md

@@ -60,11 +60,11 @@ fos_rest:
             - { path: '^/', stop: true }
 ```
 
-### 3. Configure Order Controllers
+### 3. Configure Controllers
 
-Configure the Sylius order controllers to use the legacy bridge functionality:
+Configure the Sylius controllers to use the legacy bridge functionality:
 
-**Option A: If you have NOT overridden Order/OrderItem controllers in your project**
+**Option A: If you have NOT overridden the following controllers in your project**
 
 Add the following to your `config/packages/_sylius.yaml`:
 
@@ -77,9 +77,15 @@ sylius_order:
         order_item:
             classes:
                 controller: Sylius\LegacyBridgePlugin\Controller\OrderItemController
+
+sylius_addressing:
+    resources:
+        province:
+            classes:
+                controller: Sylius\LegacyBridgePlugin\Controller\ProvinceController
 ```
 
-**Option B: If you HAVE already overridden Order/OrderItem controllers in your project**
+**Option B: If you HAVE already any of these controllers in your project**
 
 Add the appropriate traits to your existing controllers:
 
@@ -112,6 +118,21 @@ class OrderItemController extends ResourceController
 }
 ```
 
+```php
+// src/Controller/ProvinceController.php
+namespace App\Controller;
+
+use Sylius\Bundle\ResourceBundle\Controller\ResourceController;
+use Sylius\LegacyBridgePlugin\Controller\Trait\ProvinceTrait;
+
+class ProvinceController extends ResourceController
+{
+    use ProvinceTrait; // Adds: choiceOrTextFieldFormAction() and helper methods
+
+    // ... your existing custom methods
+}
+```
+
 ### 4. Update UI Configuration
 
 Replace `sylius_ui` configuration with `sylius_legacy_bridge` in your `config/packages/sylius_ui.yaml` (or wherever your UI events are configured):

config/routes/shop/ajax.yml

@@ -9,10 +9,10 @@ sylius_shop_ajax_cart:
     resource: "@SyliusLegacyBridgePlugin/config/routes/shop/ajax/cart.yml"
     prefix: /cart
 
-#sylius_shop_ajax_render_province_form:
-#    path: /render-province-form
-#    methods: [GET]
-#    defaults:
-#        _controller: sylius.controller.province::choiceOrTextFieldFormAction
-#        _sylius:
-#            template: "@SyliusShop/Common/Form/_province.html.twig"
+sylius_shop_ajax_render_province_form:
+    path: /render-province-form
+    methods: [GET]
+    defaults:
+        _controller: sylius.controller.province::choiceOrTextFieldFormAction
+        _sylius:
+            template: "@SyliusShop/Common/Form/_province.html.twig"

config/routes/shop/ajax/user.yml

@@ -1,15 +1,15 @@
 # This file is part of the Sylius package.
 # (c) Sylius Sp. z o.o.
 
-#sylius_shop_ajax_user_check_action:
-#    path: /check
-#    methods: [GET]
-#    defaults:
-#        _controller: sylius.controller.shop_user::showAction
-#        _format: json
-#        _sylius:
-#            repository:
-#                method: findOneByEmail
-#                arguments:
-#                    email: $email
-#            serialization_groups: [Secured]
+sylius_shop_ajax_user_check_action:
+    path: /check
+    methods: [GET]
+    defaults:
+        _controller: sylius.controller.shop_user::showAction
+        _format: json
+        _sylius:
+            repository:
+                method: findOneByEmail
+                arguments:
+                    email: $email
+            serialization_groups: [Secured]

src/Controller/ProvinceController.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\LegacyBridgePlugin\Controller;
+
+use Sylius\Bundle\ResourceBundle\Controller\ResourceController;
+use Sylius\LegacyBridgePlugin\Controller\Trait\ProvinceTrait;
+
+class ProvinceController extends ResourceController
+{
+    use ProvinceTrait;
+}

src/Controller/Trait/ProvinceTrait.php

@@ -0,0 +1,86 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\LegacyBridgePlugin\Controller\Trait;
+
+use Sylius\Bundle\AddressingBundle\Form\Type\ProvinceCodeChoiceType;
+use Sylius\Bundle\ResourceBundle\Controller\ResourceController;
+use Sylius\Component\Addressing\Model\CountryInterface;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
+use Symfony\Component\Form\FormInterface;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
+use Symfony\Component\Security\Core\Exception\AccessDeniedException;
+
+/** @mixin ResourceController */
+trait ProvinceTrait
+{
+    /**
+     * @throws AccessDeniedException
+     * @throws NotFoundHttpException
+     */
+    public function choiceOrTextFieldFormAction(Request $request): Response
+    {
+        $configuration = $this->requestConfigurationFactory->create($this->metadata, $request);
+
+        if (!$configuration->isHtmlRequest() || null === $countryCode = $request->query->get('countryCode')) {
+            throw new AccessDeniedException();
+        }
+
+        /** @var CountryInterface|null $country */
+        $country = $this->get('sylius.repository.country')->findOneBy(['code' => $countryCode]);
+        if ($country === null) {
+            throw new NotFoundHttpException('Requested country does not exist.');
+        }
+
+        if (!$country->hasProvinces()) {
+            $form = $this->createProvinceTextForm();
+
+            $content = $this->renderView(
+                $configuration->getTemplate('_provinceText.html'),
+                [
+                    'metadata' => $this->metadata,
+                    'form' => $form->createView(),
+                ],
+            );
+
+            return new JsonResponse([
+                'content' => $content,
+            ]);
+        }
+
+        $form = $this->createProvinceChoiceForm($country);
+
+        $content = $this->renderView(
+            $configuration->getTemplate('_provinceChoice.html'),
+            [
+                'metadata' => $this->metadata,
+                'form' => $form->createView(),
+            ],
+        );
+
+        return new JsonResponse([
+            'content' => $content,
+        ]);
+    }
+
+    protected function createProvinceChoiceForm(CountryInterface $country): FormInterface
+    {
+        return $this->get('form.factory')->createNamed('sylius_address_province', ProvinceCodeChoiceType::class, null, [
+            'country' => $country,
+            'label' => 'sylius.form.address.province',
+            'placeholder' => 'sylius.form.province.select',
+        ]);
+    }
+
+    protected function createProvinceTextForm(): FormInterface
+    {
+        return $this->get('form.factory')->createNamed('sylius_address_province', TextType::class, null, [
+            'required' => false,
+            'label' => 'sylius.form.address.province',
+        ]);
+    }
+}