Merge pull request Sylius#7828 from foobarflies/form-type-doc

[Documentation] Add missing 'form-type' attribute
ezecosystem · Mar 24, 2017 · b1ff749 · b1ff749
2 parents 3f1a6d9 + 21c7925
commit b1ff749
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 26 deletions.
diff --git a/docs/cookbook/custom-promotion-action.rst b/docs/cookbook/custom-promotion-action.rst
@@ -82,20 +82,6 @@ This class needs also a ``isConfigurationValid()`` method which was omitted in t
         }
     }
 
-Register the action as a service
---------------------------------
-
-In the ``app/config/services.yml`` configure:
-
-.. code-block:: yaml
-
-    # app/config/services.yml
-    app.promotion_action.cheapest_product_discount:
-        class: AppBundle\Promotion\Action\CheapestProductDiscountPromotionActionCommand
-        arguments: ['@sylius.proportional_integer_distributor', '@sylius.promotion.units_promotion_adjustments_applicator']
-        tags:
-            - { name: sylius.promotion_action, type: cheapest_product_discount, label: Cheapest product discount }
-
 Prepare a configuration form type for the admin panel
 -----------------------------------------------------
 
@@ -120,6 +106,21 @@ The new action needs a form type to be available in the admin panel, while creat
         }
     }
 
+Register the action as a service
+--------------------------------
+
+In the ``app/config/services.yml`` configure:
+
+.. code-block:: yaml
+
+    # app/config/services.yml
+    app.promotion_action.cheapest_product_discount:
+        class: AppBundle\Promotion\Action\CheapestProductDiscountPromotionActionCommand
+        arguments: ['@sylius.proportional_integer_distributor', '@sylius.promotion.units_promotion_adjustments_applicator']
+        tags:
+            - { name: sylius.promotion_action, type: cheapest_product_discount, form-type: AppBundle\Form\Type\Action\CheapestProductDiscountConfigurationType, label: Cheapest product discount }
+
+
 Register the form type as a service
 -----------------------------------
 

diff --git a/docs/cookbook/custom-promotion-rule.rst b/docs/cookbook/custom-promotion-rule.rst
@@ -41,16 +41,6 @@ The new Rule needs a RuleChecker class:
         }
     }
 
-Register the new rule checker as a service in the ``app/config/services.yml``:
-
-.. code-block:: yaml
-
-    # apps/config/services.yml
-    app.promotion_rule_checker.premium_customer:
-        class: AppBundle\Promotion\Checker\Rule\PremiumCustomerRuleChecker
-        tags:
-            - { name: sylius.promotion_rule_checker, type: premium_customer, label: Premium customer }
-
 Prepare a configuration form type for your new rule
 ---------------------------------------------------
 
@@ -87,6 +77,18 @@ And configure it in the ``app/config/services.yml``:
         tags:
             - { name: form.type }
 
+
+Register the new rule checker as a service in the ``app/config/services.yml``:
+
+.. code-block:: yaml
+
+    # apps/config/services.yml
+    app.promotion_rule_checker.premium_customer:
+        class: AppBundle\Promotion\Checker\Rule\PremiumCustomerRuleChecker
+        tags:
+            - { name: sylius.promotion_rule_checker, type: premium_customer, form-type: AppBundle\Form\Type\Rule\PremiumCustomerConfigurationType, label: Premium customer }
+
+
 That's all. You will now be able to choose the new rule while creating a new promotion.
 
 .. tip::

diff --git a/...lius/Bundle/PromotionBundle/DependencyInjection/Compiler/RegisterPromotionActionsPass.php b/...lius/Bundle/PromotionBundle/DependencyInjection/Compiler/RegisterPromotionActionsPass.php
@@ -35,7 +35,7 @@ public function process(ContainerBuilder $container)
         $promotionActionTypeToLabelMap = [];
         foreach ($container->findTaggedServiceIds('sylius.promotion_action') as $id => $attributes) {
             if (!isset($attributes[0]['type'], $attributes[0]['label'], $attributes[0]['form-type'])) {
-                throw new \InvalidArgumentException('Tagged promotion action needs to have `type`, `form-type` and `label` attributes.');
+                throw new \InvalidArgumentException('Tagged promotion action `'.$id.'` needs to have `type`, `form-type` and `label` attributes.');
             }
 
             $promotionActionTypeToLabelMap[$attributes[0]['type']] = $attributes[0]['label'];

diff --git a/src/Sylius/Bundle/PromotionBundle/DependencyInjection/Compiler/RegisterRuleCheckersPass.php b/src/Sylius/Bundle/PromotionBundle/DependencyInjection/Compiler/RegisterRuleCheckersPass.php
@@ -35,7 +35,7 @@ public function process(ContainerBuilder $container)
         $promotionRuleCheckerTypeToLabelMap = [];
         foreach ($container->findTaggedServiceIds('sylius.promotion_rule_checker') as $id => $attributes) {
             if (!isset($attributes[0]['type'], $attributes[0]['label'], $attributes[0]['form-type'])) {
-                throw new \InvalidArgumentException('Tagged rule checker needs to have `type`, `form-type` and `label` attributes.');
+                throw new \InvalidArgumentException('Tagged rule checker `'.$id.'` needs to have `type`, `form-type` and `label` attributes.');
             }
 
             $promotionRuleCheckerTypeToLabelMap[$attributes[0]['type']] = $attributes[0]['label'];