Conditions refactored

Author: mnocon

code_samples/discounts/src/Discounts/Step/Step1/AnniversaryConditionStepEventSubscriber.php

@@ -0,0 +1,51 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Discounts\Step;
+
+use App\Discounts\Condition\IsAccountAnniversary;
+use Ibexa\Contracts\Discounts\Event\CreateFormDataEvent;
+use Ibexa\Contracts\Discounts\Event\MapDiscountToFormDataEvent;
+use Ibexa\Contracts\Discounts\Value\DiscountType;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Contracts\EventDispatcher\Event;
+
+final class AnniversaryConditionStepEventSubscriber implements EventSubscriberInterface
+{
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            CreateFormDataEvent::class => 'addAnniversaryConditionStep',
+            MapDiscountToFormDataEvent::class => 'addAnniversaryConditionStep',
+        ];
+    }
+
+    /**
+     * @param \Ibexa\Contracts\Discounts\Event\CreateFormDataEvent|\Ibexa\Contracts\Discounts\Event\MapDiscountToFormDataEvent $event
+     */
+    public function addAnniversaryConditionStep(Event $event): void
+    {
+        $data = $event->getData();
+        if ($data->getType() !== DiscountType::CART) {
+            return;
+        }
+
+        /** @var \App\Discounts\Condition\IsAccountAnniversary $discount */
+        $discount = $event instanceof MapDiscountToFormDataEvent ?
+                    $event->getDiscount()->getConditionByIdentifier(IsAccountAnniversary::IDENTIFIER) :
+                    null;
+
+        $conditionStep = $discount !== null ?
+                        new AnniversaryConditionStep(true, $discount->getTolerance()) :
+                        new AnniversaryConditionStep();
+
+        $event->setData(
+            $event->getData()->withStep(
+                $conditionStep,
+                AnniversaryConditionStep::IDENTIFIER,
+                'Anniversary Condition',
+                -45 // Priority
+            )
+        );
+    }
+}

code_samples/discounts/src/Discounts/Step/AnniversaryConditionStepEventSubscriber.php renamed to code_samples/discounts/src/Discounts/Step/Step2/AnniversaryConditionStepEventSubscriber.php

@@ -0,0 +1,9 @@
+<?php declare(strict_types=1);
+
+namespace App\Form\Data;
+
+use Ibexa\Contracts\Discounts\Admin\Form\Data\AbstractDiscountValue;
+
+final class PurchasingPowerParityValue extends AbstractDiscountValue
+{
+}

code_samples/discounts/src/Form/Data/PurchasingPowerParityValue.php

@@ -0,0 +1,26 @@
+<?php declare(strict_types=1);
+
+namespace App\Form\FormMapper;
+
+use App\Form\Data\PurchasingPowerParityValue;
+use App\Form\Type\DiscountValue\PurchasingPowerParityValueType;
+use Ibexa\Contracts\Discounts\Admin\Form\Data\DiscountValueInterface;
+use Ibexa\Contracts\Discounts\Admin\Form\DiscountValueFormTypeMapperInterface;
+
+final class PurchasingPowerParityDiscountValueFormTypeMapper implements DiscountValueFormTypeMapperInterface
+{
+    public function hasFormTypeForData(DiscountValueInterface $data): bool
+    {
+        return $data instanceof PurchasingPowerParityValue;
+    }
+
+    public function getFormTypeForData(DiscountValueInterface $data): ?string
+    {
+        return $data instanceof PurchasingPowerParityValue ? PurchasingPowerParityValueType::class : null;
+    }
+
+    public function getFormTypeOptionsForData(DiscountValueInterface $data): array
+    {
+        return [];
+    }
+}

code_samples/discounts/src/Form/FormMapper/PurchasingPowerParityDiscountValueFormTypeMapper.php

@@ -0,0 +1,31 @@
+<?php declare(strict_types=1);
+
+namespace App\Form\FormMapper;
+
+use App\Discounts\Rule\PurchasingPowerParityRule;
+use Ibexa\Bundle\Discounts\Form\FormMapper\AbstractFormMapper;
+use JMS\TranslationBundle\Model\Message;
+use JMS\TranslationBundle\Translation\TranslationContainerInterface;
+
+final class PurchasingPowerParityFormMapper extends AbstractFormMapper implements TranslationContainerInterface
+{
+    public function getDiscountRuleTypes(?string $type): array
+    {
+        return [PurchasingPowerParityRule::TYPE];
+    }
+
+    public function supports(string $type, string $ruleType): bool
+    {
+        return $ruleType === PurchasingPowerParityRule::TYPE;
+    }
+
+    public static function getTranslationMessages(): array
+    {
+        return [
+            Message::create(
+                sprintf('%s.%s', self::TRANSLATION_PREFIX, PurchasingPowerParityRule::TYPE),
+                'ibexa_discounts',
+            )->setDesc('Regional'),
+        ];
+    }
+}

code_samples/discounts/src/Form/FormMapper/PurchasingPowerParityFormMapper.php

@@ -0,0 +1,62 @@
+<?php declare(strict_types=1);
+
+namespace App\Form\FormMapper;
+
+use App\Discounts\Rule\PurchasingPowerParityRule;
+use App\Form\Data\PurchasingPowerParityValue;
+use Ibexa\Contracts\Discounts\Admin\Form\Data\DiscountValueInterface;
+use Ibexa\Contracts\Discounts\Admin\FormMapper\DiscountValueMapperInterface;
+use Ibexa\Contracts\Discounts\Value\DiscountInterface;
+use Ibexa\Contracts\Discounts\Value\Struct\DiscountCreateStruct;
+use Ibexa\Contracts\Discounts\Value\Struct\DiscountUpdateStruct;
+use LogicException;
+
+final class PurchasingPowerParityValueMapper implements DiscountValueMapperInterface
+{
+    public function createFormData(string $type, string $ruleType): DiscountValueInterface
+    {
+        if ($ruleType !== PurchasingPowerParityRule::TYPE) {
+            throw new LogicException('Not implemented');
+        }
+
+        return new PurchasingPowerParityValue();
+    }
+
+    public function mapDiscountToFormData(DiscountInterface $discount): DiscountValueInterface
+    {
+        $discountRule = $discount->getRule();
+        if (!$discountRule instanceof PurchasingPowerParityRule) {
+            throw new LogicException('Not implemented');
+        }
+
+        return new PurchasingPowerParityValue();
+    }
+
+    public function mapCreateDataToStruct(
+        DiscountValueInterface $data,
+        DiscountCreateStruct $struct
+    ): void {
+        $this->addRuleToStruct($data, $struct);
+    }
+
+    public function mapUpdateDataToStruct(
+        DiscountInterface $discount,
+        DiscountValueInterface $data,
+        DiscountUpdateStruct $struct
+    ): void {
+        $this->addRuleToStruct($data, $struct);
+    }
+
+    /**
+     * @param \Ibexa\Contracts\Discounts\Value\Struct\DiscountCreateStruct|\Ibexa\Contracts\Discounts\Value\Struct\DiscountUpdateStruct $struct
+     */
+    private function addRuleToStruct(DiscountValueInterface $data, $struct): void
+    {
+        if (!$data instanceof PurchasingPowerParityValue) {
+            throw new LogicException('Not implemented');
+        }
+
+        $rule = new PurchasingPowerParityRule();
+        $struct->setRule($rule);
+    }
+}

code_samples/discounts/src/Form/FormMapper/PurchasingPowerParityValueMapper.php

@@ -0,0 +1,75 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Form\Type\DiscountValue;
+
+use App\Form\Data\PurchasingPowerParityValue;
+use Ibexa\Bundle\Discounts\Form\Type\DiscountValueType;
+use Ibexa\Contracts\ProductCatalog\Values\RegionInterface;
+use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Event\PostSubmitEvent;
+use Symfony\Component\Form\Event\PreSetDataEvent;
+use Symfony\Component\Form\Extension\Core\Type\FormType;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\Form\FormEvents;
+use Symfony\Component\Form\FormInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/**
+ * @extends \Symfony\Component\Form\AbstractType<\App\Form\Data\PurchasingPowerParityValue>
+ */
+final class PurchasingPowerParityValueType  extends AbstractType
+{
+    public function buildForm(FormBuilderInterface $builder, array $options): void
+    {
+        $availableRegionHandler = static function (FormInterface $form, PurchasingPowerParityValue $data): void {
+            $regions = $data->getDiscountData()->getGeneralProperties()->getRegions();
+            $regionNames = implode(', ', array_map(static function (RegionInterface $region): string {
+                return $region->getIdentifier();
+            }, $regions));
+
+            $options = [
+                'required' => false,
+                'disabled' => true,
+                'label' => 'This discount applies to the following regions',
+                'data' => $regionNames,
+            ];
+
+            $form->add('value', TextType::class, $options);
+        };
+
+        $builder->add('type', FormType::class, [
+            'mapped' => false,
+            'label' => false,
+        ]);
+
+        $builder->addEventListener(
+            FormEvents::PRE_SET_DATA,
+            static function (PreSetDataEvent $event) use ($availableRegionHandler): void {
+                $form = $event->getForm();
+                $availableRegionHandler($form, $event->getData());
+            },
+        );
+        $builder->get('type')->addEventListener(
+            FormEvents::POST_SUBMIT,
+            static function (PostSubmitEvent $event) use ($availableRegionHandler): void {
+                $form = $event->getForm()->getParent();
+                assert($form !== null);
+                $availableRegionHandler($form, $form->getData());
+            },
+        );
+    }
+
+    public function getParent(): string
+    {
+        return DiscountValueType::class;
+    }
+
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+        $resolver->setDefaults([
+            'data_class' => PurchasingPowerParityValue::class,
+        ]);
+    }
+}

code_samples/discounts/src/Form/Type/DiscountValue/PurchasingPowerParityValueType.php

@@ -18,7 +18,7 @@ Together with the existing [events](event_reference.md) and the [Discounts PHP A
     - Konrad Oboza: [Introduction to the Discounts system in Ibexa DXP](https://www.youtube.com/watch?v=kTgtxY38srw)
     - Paweł Niedzielski: [Extending new Discounts to suit your needs](https://www.youtube.com/watch?v=pDJxEKJLwPs)
 
-## Create custom conditions
+## Create custom conditions and rules
 
 With custom [conditions](discounts_api.md#conditions) you can create more advanced discounts that apply only in specific scenarios.
 
@@ -122,7 +122,7 @@ You can now use the condition using the PHP API.
 
 To learn how to integrate it into the back office, see [Extend Discounts wizard](extend_discounts_wizard.md).
 
-## Create custom rules
+### Implement custom rules
 
 The following example implements a [purchasing power parity](https://en.wikipedia.org/wiki/Purchasing_power_parity) discount, adjusting product's price in the cart based on buyer's region. 
 You could use it, for example, in regions sharing the same currency and apply the rule only to them by using the [`IsInRegions` condition](discounts_api.md#conditions).

docs/discounts/extend_discounts.md

@@ -49,8 +49,8 @@ It contains the step identifier, properties for storing form data, and extends t
 
 Then, create a new event listener listening to the [`CreateFormDataEvent` and `MapDiscountToFormDataEvent` events](discounts_events.md#form):
 
-``` php hl_lines="21-22 31-55"
-[[= include_file('code_samples/discounts/src/Discounts/Step/AnniversaryConditionStepEventSubscriber.php') =]]
+``` php hl_lines="18-19 26-50"
+[[= include_file('code_samples/discounts/src/Discounts/Step/Step1/AnniversaryConditionStepEventSubscriber.php') =]]
 ```
 
 Attaching the `addAnniversaryConditionStep()` method to both these events adds the custom step both in discount creation and edit forms.
@@ -88,14 +88,23 @@ The new form step, including its form fields, are now part of the discounts wiza
 
 The last task is making sure that the form data is correctly saved by attaching it to the discounts API structs.
 
-The previously created `addStepDataToStruct()` method in `AnniversaryConditionStepEventSubscriber` is responsible for it:
+Expand the previously created `AnniversaryConditionStepEventSubscriber` to listen to two additional events:
+
+- [`CreateDiscountCreateStructEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Discounts-Event-CreateDiscountCreateStructEvent.html)
+- [`CreateDiscountUpdateStructEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Discounts-Event-CreateDiscountUpdateStructEvent.html)
+
+and add the `addStepDataToStruct()` method:
 
 ``` php hl_lines="23-24 57-70"
-[[= include_file('code_samples/discounts/src/Discounts/Step/AnniversaryConditionStepEventSubscriber.php') =]]
+[[= include_file('code_samples/discounts/src/Discounts/Step/Step2/AnniversaryConditionStepEventSubscriber.php') =]]
 ```
 
 When the form is submitted, this method extracts information whether the store manager enabled the anniversary discount in the form and adds the condition to make sure this data is properly saved.
 
 The custom condition is now integrated with the discounts wizard and can be used by store managers to attract new customers.
 
 ## Integrate custom rules
+
+This example continues the [purchasing power parity rule example](extend_discounts.md#implement-custom-rules), integrating the rule with the wizard.
+
+