Create Promotion Condition page. #264
Conversation
user/pages/03.commerce2/02.developer-guide/09.promotions/02.create-a-condition/docs.md
Outdated
Show resolved
Hide resolved
user/pages/03.commerce2/02.developer-guide/09.promotions/02.create-a-condition/docs.md
Outdated
Show resolved
Hide resolved
user/pages/03.commerce2/02.developer-guide/09.promotions/02.create-a-condition/docs.md
Outdated
Show resolved
Hide resolved
user/pages/03.commerce2/02.developer-guide/09.promotions/02.create-a-condition/docs.md
Outdated
Show resolved
Hide resolved
user/pages/03.commerce2/02.developer-guide/09.promotions/02.create-a-condition/docs.md
Outdated
Show resolved
Hide resolved
user/pages/03.commerce2/02.developer-guide/09.promotions/02.create-a-condition/docs.md
Outdated
Show resolved
Hide resolved
user/pages/03.commerce2/02.developer-guide/09.promotions/02.create-a-condition/docs.md
Outdated
Show resolved
Hide resolved
|  | ||
|
|
||
|
|
||
| Minimum requirements to build a condition: |
There was a problem hiding this comment.
This begs the question "what are all the requirements?" You also have a colon in this title but not any others.
What do you think about calling this section "Creating Conditions"?
There was a problem hiding this comment.
Agreed on "Creating Conditions" but I think it should be "Creating Promotion Conditions"
There was a problem hiding this comment.
This page is in the "core" section, not the promotion section of the docs.
user/pages/03.commerce2/02.developer-guide/03.core/01.conditions/docs.md
Outdated
Show resolved
Hide resolved
user/pages/03.commerce2/02.developer-guide/03.core/01.conditions/docs.md
Show resolved
Hide resolved
user/pages/03.commerce2/02.developer-guide/03.core/01.conditions/docs.md
Outdated
Show resolved
Hide resolved
user/pages/03.commerce2/02.developer-guide/03.core/01.conditions/docs.md
Outdated
Show resolved
Hide resolved
| order meets a certain criteria and to return a boolean TRUE if so. | ||
|
|
||
| ``` | ||
| // *** Remember annotations are inherited from ConditionInterface.*** |
There was a problem hiding this comment.
What does this mean? Annotations aren't inherited.
There was a problem hiding this comment.
I think Travis means annotations aren't inheritable.
| public function evaluate(EntityInterface $entity) { | ||
|
|
||
| // This line is essential as it ensures this condition will only run for the | ||
| // 'entity_type' declared in this condition's annotations. |
There was a problem hiding this comment.
This doesn't mean it only runs for that entity type, it ensures the site will crash if it's not that type (assuming nothing catches the exception).
| @@ -4,4 +4,7 @@ taxonomy: | |||
| category: docs | |||
| --- | |||
|
|
|||
| See [Core Components / Conditions](https://docs.drupalcommerce.org/commerce2/developer-guide/core/conditions) | |||
There was a problem hiding this comment.
You should be able to link to pages internally rather than by the whole domain and everything.
| * If the total quantity of all order items is greater than or equal to the | ||
| * quantity that the user set in the configuration form, return TRUE. If not, | ||
| * return FALSE and the promotion will not be applied to the order. | ||
| */ |
There was a problem hiding this comment.
As above I'd leave out most of all of these explanations for the obvious stuff - the Calculator:add bit is self-explanatory and this following bit it just knowing what the comparison operators do.
There was a problem hiding this comment.
Also, this comment style is not Drupal code style friendly.
user/pages/03.commerce2/02.developer-guide/03.core/01.conditions/docs.md
Outdated
Show resolved
Hide resolved
user/pages/03.commerce2/02.developer-guide/03.core/01.conditions/docs.md
Outdated
Show resolved
Hide resolved
user/pages/03.commerce2/02.developer-guide/03.core/01.conditions/docs.md
Show resolved
Hide resolved
|  | ||
|
|
||
|
|
||
| Minimum requirements to build a condition: |
There was a problem hiding this comment.
Agreed on "Creating Conditions" but I think it should be "Creating Promotion Conditions"
user/pages/03.commerce2/02.developer-guide/03.core/01.conditions/docs.md
Outdated
Show resolved
Hide resolved
user/pages/03.commerce2/02.developer-guide/03.core/01.conditions/docs.md
Outdated
Show resolved
Hide resolved
| order meets a certain criteria and to return a boolean TRUE if so. | ||
|
|
||
| ``` | ||
| // *** Remember annotations are inherited from ConditionInterface.*** |
There was a problem hiding this comment.
I think Travis means annotations aren't inheritable.
| $quantity = '0'; | ||
| foreach ($order->getItems() as $order_item) { | ||
|
|
||
| // First assess if each order item can apply to this condition. |
There was a problem hiding this comment.
code formatting, needs spaces here.
| } | ||
| } | ||
|
|
||
| // Get the quantity from each item and add to a running total. |
There was a problem hiding this comment.
Not a fan of this indentation thing. If you want to have inline comments, break the code up into smaller blocks of code with your comment in between.
| * If the total quantity of all order items is greater than or equal to the | ||
| * quantity that the user set in the configuration form, return TRUE. If not, | ||
| * return FALSE and the promotion will not be applied to the order. | ||
| */ |
There was a problem hiding this comment.
Also, this comment style is not Drupal code style friendly.
| @@ -4,4 +4,7 @@ taxonomy: | |||
| category: docs | |||
| --- | |||
|
|
|||
| See [Core Components / Conditions](https://docs.drupalcommerce.org/commerce2/developer-guide/core/conditions) | |||
| for an explanation of a promotion condition. | |||
|
|
|||
| ! We need help filling out this section! Feel free to follow the *edit this page* link and contribute. | |||
There was a problem hiding this comment.
You'll want to remove the ! We need help... section.
There was a problem hiding this comment.
I apologize for not looking at this PR more carefully until now. When I saw the, "Create Promotion Condition" page title, I assumed this was work for the "Create a condition" page within the "Promotions" section of the documentation. In the meantime, a general "Core" condition page was merged in. There's a lot of good information here, though. I'm wondering whether it would make sense to rework the start of this a bit, to make it specific to "Promotion" conditions, since the rest of the document focuses on that. And then it would be a great addition to the "Promotions" section of the documentation.
This is a thread to get a page created on howto create a condition.