Fix to allow adding products with a customer option to the cart

README.md

@@ -28,6 +28,43 @@ imports:
 ```yaml
 brille24_customer_options:
     resource: "@Brille24SyliusCustomerOptionsPlugin/Resources/config/app/routing.yml"
+
+sylius_shop_ajax_cart_add_item:
+  path: ajax/cart/add
+  methods: [POST]
+  defaults:
+    _controller: sylius.controller.order_item::addAction
+    _format: json
+    _sylius:
+      factory:
+        method: createForProductWithCustomerOption
+        arguments: [expr:notFoundOnNull(service('sylius.repository.product').find($productId))]
+      form:
+        type: Sylius\Bundle\CoreBundle\Form\Type\Order\AddToCartType
+        options:
+          product: expr:notFoundOnNull(service('sylius.repository.product').find($productId))
+      redirect:
+        route: sylius_shop_cart_summary
+        parameters: {}
+      flash: sylius.cart.add_item
+
+sylius_shop_partial_cart_add_item:
+  path: cart/add-item
+  methods: [GET]
+  defaults:
+    _controller: sylius.controller.order_item::addAction
+    _sylius:
+      template: $template
+      factory:
+        method: createForProductWithCustomerOption
+        arguments: [expr:notFoundOnNull(service('sylius.repository.product').find($productId))]
+      form:
+        type: Sylius\Bundle\CoreBundle\Form\Type\Order\AddToCartType
+        options:
+          product: expr:notFoundOnNull(service('sylius.repository.product').find($productId))
+      redirect:
+        route: sylius_shop_cart_summary
+        parameters: {}
 ```
 
 * Copy the template overrides from the plugin directory

src/EventListener/AddToCartListener.php → src/Factory/CartItemFactory.php

@@ -10,45 +10,66 @@
  */
 declare(strict_types=1);
 
-namespace Brille24\SyliusCustomerOptionsPlugin\EventListener;
+namespace Brille24\SyliusCustomerOptionsPlugin\Factory;
 
-use Brille24\SyliusCustomerOptionsPlugin\Entity\OrderItemInterface;
 use Brille24\SyliusCustomerOptionsPlugin\Enumerations\CustomerOptionTypeEnum;
-use Brille24\SyliusCustomerOptionsPlugin\Factory\OrderItemOptionFactoryInterface;
 use Brille24\SyliusCustomerOptionsPlugin\Repository\CustomerOptionRepositoryInterface;
-use Doctrine\ORM\EntityManagerInterface;
-use Sylius\Bundle\ResourceBundle\Event\ResourceControllerEvent;
+use Sylius\Component\Core\Factory\CartItemFactoryInterface;
 use Sylius\Component\Core\Model\OrderInterface;
-use Sylius\Component\Order\Processor\OrderProcessorInterface;
+use Sylius\Component\Core\Model\OrderItemInterface;
+use Sylius\Component\Core\Model\ProductInterface;
+use Sylius\Component\Product\Resolver\ProductVariantResolverInterface;
+use Sylius\Component\Resource\Factory\FactoryInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\RequestStack;
 use Webmozart\Assert\Assert;
 
-final class AddToCartListener
+class CartItemFactory implements CartItemFactoryInterface
 {
+    private CartItemFactoryInterface $decoratedFactory;
+    private ProductVariantResolverInterface $variantResolver;
+    private RequestStack $requestStack;
+    private OrderItemOptionFactoryInterface $orderItemOptionFactory;
+    private CustomerOptionRepositoryInterface $customerOptionRepository;
+
     public function __construct(
-        private RequestStack $requestStack,
-        private EntityManagerInterface $entityManager,
-        private OrderItemOptionFactoryInterface $orderItemOptionFactory,
-        private OrderProcessorInterface $orderProcessor,
-        private CustomerOptionRepositoryInterface $customerOptionRepository,
-    )
+        FactoryInterface $decoratedFactory,
+        ProductVariantResolverInterface $variantResolver,
+        RequestStack $requestStack,
+        OrderItemOptionFactoryInterface $orderItemOptionFactory,
+        CustomerOptionRepositoryInterface $customerOptionRepository
+    ) {
+        $this->decoratedFactory = new \Sylius\Component\Core\Factory\CartItemFactory($decoratedFactory, $variantResolver);
+        $this->variantResolver = $variantResolver;
+        $this->requestStack = $requestStack;
+        $this->orderItemOptionFactory = $orderItemOptionFactory;
+        $this->customerOptionRepository = $customerOptionRepository;
+    }
+
+    public function createForProduct(ProductInterface $product): OrderItemInterface
     {
+        return $this->decoratedFactory->createForProduct($product);
     }
 
-    public function addItemToCart(ResourceControllerEvent $event): void
+    public function createForCart(OrderInterface $order): OrderItemInterface
     {
-        /** @var OrderItemInterface $orderItem */
-        $orderItem = $event->getSubject();
+        return $this->decoratedFactory->createForCart($order);
+    }
 
-        // If the order is null, it's an old order item with an existing reference in the database
-        if ($orderItem->getOrder() === null) {
-            return;
-        }
+    public function createNew()
+    {
+        return $this->decoratedFactory->createNew();
+    }
+
+    public function createForProductWithCustomerOption(ProductInterface $product): OrderItemInterface
+    {
+       /** @var OrderItemInterface $cartItem */
+        $cartItem = $this->createNew();
+        $cartItem->setVariant($this->variantResolver->getVariant($product));
 
         $request = $this->requestStack->getCurrentRequest();
         if (!$request instanceof Request) {
-            return;
+            return $cartItem;
         }
 
         $customerOptionConfiguration = $this->getCustomerOptionsFromRequest($request);
@@ -69,28 +90,26 @@ public function addItemToCart(ResourceControllerEvent $event): void
             foreach ($valueArray as $value) {
                 // Creating the item
                 $salesOrderConfiguration = $this->orderItemOptionFactory->createNewFromStrings(
-                    $orderItem,
+                    $cartItem,
                     $customerOptionCode,
-                    $value,
+                    $value
                 );
 
-                $this->entityManager->persist($salesOrderConfiguration);
-
                 $salesOrderConfigurations[] = $salesOrderConfiguration;
             }
         }
 
-        $orderItem->setCustomerOptionConfiguration($salesOrderConfigurations);
-        /** @var OrderInterface $order */
-        $order = $orderItem->getOrder();
-        $this->orderProcessor->process($order);
+        $cartItem->setCustomerOptionConfiguration($salesOrderConfigurations);
 
-        $this->entityManager->persist($orderItem);
-        $this->entityManager->flush();
+        return $cartItem;
     }
 
     /**
      * Gets the customer options from the request
+     *
+     * @param Request $request
+     *
+     * @return array
      */
     public function getCustomerOptionsFromRequest(Request $request): array
     {
@@ -109,20 +128,20 @@ public function getCustomerOptionsFromRequest(Request $request): array
 
             switch ($customerOption->getType()) {
                 case CustomerOptionTypeEnum::DATE:
-                    $day = $value['day'];
-                    $month = $value['month'];
-                    $year = $value['year'];
+                    $day                                  = $value['day'];
+                    $month                                = $value['month'];
+                    $year                                 = $value['year'];
                     $addToCart['customer_options'][$code] = sprintf('%d-%d-%d', $year, $month, $day);
 
                     break;
                 case CustomerOptionTypeEnum::DATETIME:
-                    $date = $value['date'];
-                    $time = $value['time'];
-                    $day = $date['day'];
+                    $date  = $value['date'];
+                    $time  = $value['time'];
+                    $day   = $date['day'];
                     $month = $date['month'];
-                    $year = $date['year'];
+                    $year  = $date['year'];
 
-                    $hour = $time['hour'] ?? 0;
+                    $hour   = $time['hour'] ?? 0;
                     $minute = $time['minute'] ?? 0;
 
                     $addToCart['customer_options'][$code] = sprintf('%d-%d-%d %d:%d', $year, $month, $day, $hour, $minute);

src/Resources/config/app/services/eventListener.xml

@@ -1,15 +1,5 @@
 <container xmlns="http://symfony.com/schema/dic/services">
     <services>
-
-       <service class="Brille24\SyliusCustomerOptionsPlugin\EventListener\AddToCartListener" id="brille24.customer_options_plugin.event.add_to_cart_listener">
-           <tag name="kernel.event_listener" event="sylius.order_item.post_add" method="addItemToCart"/>
-           <argument type="service" id="request_stack"/>
-           <argument type="service" id="doctrine.orm.default_entity_manager"/>
-           <argument type="service" id="brille24.factory.order_item_option"/>
-           <argument type="service" id="sylius.order_processing.order_processor.composite"/>
-           <argument type="service" id="brille24.repository.customer_option"/>
-       </service>
-
         <service
                 class="Brille24\SyliusCustomerOptionsPlugin\EventListener\CustomerOptionValueListener"
                 id="brille24.customer_options_plugin.event_listener.customer_option_value"

src/Resources/config/app/services/factory.xml

@@ -54,5 +54,19 @@
             <argument type="service" id="brille24.repository.customer_option_value"/>
             <argument type="service" id="brille24.customer_options_plugin.factory.customer_option_value_price_factory" />
         </service>
+
+        <service
+                class="Brille24\SyliusCustomerOptionsPlugin\Factory\CartItemFactory"
+                id="sylius.custom_factory.order_item"
+                decorates="sylius.factory.order_item"
+                decoration-priority="256"
+                public="false"
+        >
+            <argument type="service" id="sylius.custom_factory.order_item.inner"/>
+            <argument type="service" id="sylius.product_variant_resolver.default"/>
+            <argument type="service" id="request_stack"/>
+            <argument type="service" id="brille24.factory.order_item_option"/>
+            <argument type="service" id="brille24.repository.customer_option"/>
+        </service>
     </services>
 </container>

src/Traits/OrderItemCustomerOptionCapableTrait.php

@@ -91,8 +91,32 @@ public function equals(SyliusOrderItemInterface $item): bool
             return false;
         }
 
-        $product = $item instanceof self ? $item->getProduct() : null;
+        if (!$item instanceof self) {
+            return false;
+        }
+
+        /** @var OrderItemOptionInterface[] $itemCustomerConfiguration */
+        $itemCustomerConfiguration = $item->getCustomerOptionConfiguration(true);
+        $curItemCustomerConfiguration = $this->getCustomerOptionConfiguration(true);
+
+        // configuration array size needs to be identical
+        if (count($itemCustomerConfiguration) !== count($curItemCustomerConfiguration)) {
+            return false;
+        }
+
+        // configuration array keys need to match
+        $diff = array_diff_key($itemCustomerConfiguration, $curItemCustomerConfiguration);
+        if (count($diff) !== 0) {
+            return false;
+        }
+
+        // iterate over all options and compare their values
+        foreach ($itemCustomerConfiguration as $code => $value) {
+            if ($curItemCustomerConfiguration[$code]->getOptionValue() !== $value->getOptionValue()) {
+                return false;
+            }
+        }
 
-        return ($product instanceof ProductInterface) ? !$product->hasCustomerOptions() : true;
+        return true;
     }
 }