This plugin adds the option of configuring a minimum order value for each channel.
When a minimum order value is configured it is not possible to checkout the order if the subtotal of all of the items in the cart is lower the configured minimum.
Configuring a minimum order value is possible by logging in as an administrator and navigating to the channel configuration:
Choose to edit an existing channel or to add a new one:
This plugin adds a segment to the add/edit pane that can be used to set the desired minimum order value in the base currency:
By default the toggle is set to the off position and the field to enter the minimum order value is disabled. To configure the desired value use the toggle to enable the minimum order value and enter the value in the field.
When visiting the shop and not having added enough items to the shopping cart they will not be able to proceed to checkout:
The checkout button is disabled and a message is displayed, providing more insight in the current status:
When clicking the cart widget button, the checkout button is hidden:
If a visitor tries to skip ahead to the checkout process (for example by entering the url manually), the visitor will automatically be redirected to the cart summary page.
Technically what this plugin does is a few things. It adds an optional field to the channel entity and the option to configure the fields value through the admin system.
This value is used by the MinimumOrderValueReached class, which is configured as a guard on all of the transitions of the "sylius_order_checkout" state machine.
By overriding the "sylius.resolver.checkout" service and disabling the original service, the plugin is able to redirect the visitor to the cart summary page when the guard blocks the transition.
Overriding that service also means that the service needs to be configured slightly differently then before (only applicable if you have a customised checkout resolver configuration):
Whereas before the the checkout resolver could be configured through key "sylius_shop", it now needs to be done through key "nedac_sylius_minimum_order_value":
nedac_sylius_minimum_order_value:
checkout_resolver:
pattern: /checkout/.+route_map:
empty_order:
route: sylius_shop_cart_summarycart:
route: sylius_shop_checkout_addressaddressed:
route: sylius_shop_checkout_select_shippingshipping_selected:
route: sylius_shop_checkout_select_paymentshipping_skipped:
route: sylius_shop_checkout_select_paymentpayment_selected:
route: sylius_shop_checkout_completepayment_skipped:
route: sylius_shop_checkout_completeThis is the default configuration added by this plugin in src/Resources/config/config.yaml. It can be overridden on an
application level as with any Symfony bundle configuration.
Please see the official Sylius docs on how to configure the checkout resolver, should there be any need to do so.
| 1.6 |
| 1.7 |
NOTE:This plugin requires PHP 7.4 or up
Install using composer:
composer require nedac/sylius-minimum-order-value-plugin
Add to bundles.php:
# config/bundles.php<?phpreturn [ # ...Nedac\SyliusMinimumOrderValuePlugin\NedacSyliusMinimumOrderValuePlugin::class => ['all' => true], ];
Import configuration file:
# config/packages/_sylius.yamlimports: # ... - { resource: "@NedacSyliusMinimumOrderValuePlugin/Resources/config/config.yaml" }# ...
Implement the interface and use the trait in the Channel model:
# src/entity/Channel/Channel.php<?phpdeclare(strict_types=1); namespaceApp\Entity\Channel; useDoctrine\ORM\MappingasORM; useNedac\SyliusMinimumOrderValuePlugin\Model\ChannelInterfaceasNedacSyliusMinimumOrderValuePluginChannelInterface; useNedac\SyliusMinimumOrderValuePlugin\Model\MinimumOrderValueTraitasNedacSyliusMinimumOrderValuePluginMinimumOrderValueTrait; useSylius\Component\Core\Model\ChannelasBaseChannel; /** * @ORM\Entity * @ORM\Table(name="sylius_channel") */class Channel extends BaseChannel implements NedacSyliusMinimumOrderValuePluginChannelInterface { use NedacSyliusMinimumOrderValuePluginMinimumOrderValueTrait; // ... }
If the file
src/entity/Channel/Channel.phpdoes not yet exit, please create it using this example. When you do, also add the following section toconfig/packages/_sylius.yaml:sylius_channel: resources: channel: classes: model: App\Entity\Channel\Channel
Generate and run database migration:
bin/console doctrine:migrations:diff bin/console doctrine:migrations:migrate
Override templates (For Sylius 1.7 skip this step):
{# templates/bundles/SyliusAdminBundle/Channel/_form.html.twig #} {{ form_errors(form) }} <divclass="ui two column stackable grid"> <divclass="column"> <divclass="ui segment"> {{ form_errors(form) }} <divclass="two fields"> {{ form_row(form.code) }} {{ form_row(form.name) }} </div> {{ form_row(form.description) }} {{ form_row(form.enabled) }} <divclass="two fields"> <divclass="field"> {{ form_label(form.hostname) }} <divclass="ui labeled input"> <divclass="ui label">http://</div> {{ form_widget(form.hostname) }} </div> {{ form_errors(form.hostname) }} </div> {{ form_row(form.contactEmail) }} </div> <divclass="two fields"> {{ form_row(form.color) }} {{ form_row(form.themeName) }} </div> </div> <divclass="ui segment"> <h4class="ui dividing header">{{ form_label(form.shopBillingData) }}</h4> <divclass="two fields"> {{ form_row(form.shopBillingData.company) }} {{ form_row(form.shopBillingData.taxId) }} </div> <divclass="two fields"> {{ form_row(form.shopBillingData.countryCode) }} {{ form_row(form.shopBillingData.street) }} </div> <divclass="two fields"> {{ form_row(form.shopBillingData.city) }} {{ form_row(form.shopBillingData.postcode) }} </div> </div> </div> <divclass="column"> <divid="nedac-sylius-minimum-order-value-plugin-admin-before"class="ui segment"> {{ form_row(form.locales) }} {{ form_row(form.defaultLocale) }} {{ form_row(form.currencies) }} {{ form_row(form.baseCurrency) }} {{ form_row(form.defaultTaxZone) }} {{ form_row(form.taxCalculationStrategy) }} {{ form_row(form.skippingShippingStepAllowed) }} {{ form_row(form.skippingPaymentStepAllowed) }} {{ form_row(form.accountVerificationRequired) }} </div> {% ifform.minimumOrderValueisdefined %} <divid="nedac-sylius-minimum-order-value-plugin-admin-segment"class="ui segment"> {{ form_row(form.minimumOrderValue) }} <divclass="ui toggle checkbox"> <inputid="nedac-sylius-minimum-order-value-plugin-admin-toggle"type="checkbox"name="public"> <label>{{ 'nedac_sylius_minimum_order_value_plugin.ui.enabled'|trans }}</label> </div> </div> {% endif %} </div> </div>
{# templates/bundles/SyliusShopBundle/Cart/Summary/_checkout.html.twig #} {% import"@SyliusShop/Common/Macro/money.html.twig"asmoney %} {% setminimumOrderValue=cart.channel.minimumOrderValue %} {% settotal= sylius_order_items_subtotal(cart) %} {% iftotal>=minimumOrderValue %} {% setbuttonClass="ui huge primary fluid labeled icon button" %} {% else %} {% setbuttonClass="ui huge primary fluid labeled icon button disabled" %} {% setformattedMinimum= money.convertAndFormat(minimumOrderValue) %} {% setformattedDifference= money.convertAndFormat(minimumOrderValue-total) %} <divclass="ui icon negative message"> <iclass="warning icon"></i> <divclass="content"> <divclass="header">{{ 'nedac_sylius_minimum_order_value_plugin.ui.attention'|trans }}</div> <pid="nedac-sylius-minimum-order-value-plugin-message">{{ 'nedac_sylius_minimum_order_value_plugin.ui.minimum_not_yet_reached'|trans({ '%minimumOrderValue% ': formattedMinimum, '%difference%': formattedDifference })|raw('br') }}</p> </div> </div> {% endif %} <ahref="{{ path('sylius_shop_checkout_start') }}"class="{{ buttonClass }}"id="nedac-checkout-button"><iclass="check icon"></i> {{ 'sylius.ui.checkout'|trans }}</a>
{# templates/bundles/SyliusShopBundle/Cart/_widget.html.twig #} {% import"@SyliusShop/Common/Macro/money.html.twig"asmoney %} {% setminimumOrderValue=cart.channel.minimumOrderValue %} {% settotal= sylius_order_items_subtotal(cart) %} <divid="sylius-cart-button"class="ui circular cart button"> {{ sonata_block_render_event('sylius.shop.partial.cart.summary.before_widget_content', {'cart': cart}) }} <iclass="cart icon"></i> <spanid="sylius-cart-total"> {{ money.convertAndFormat(cart.itemsTotal) }} </span> {% transchoicecart.items|length %}sylius.ui.item.choice{% endtranschoice %} {{ sonata_block_render_event('sylius.shop.partial.cart.summary.after_widget_content', {'cart': cart}) }} </div> <divclass="ui large flowing cart hidden popup"id="nedac-sylius-minimum-order-value-plugin-popup"> {{ sonata_block_render_event('sylius.shop.partial.cart.summary.before_popup_content', {'cart': cart}) }} {% ifcart.empty %} {{ 'sylius.ui.your_cart_is_empty'|trans }}. {% else %} <divclass="ui list"> {% foritemincart.items %} <divclass="item">{{ item.quantity }} x <strong>{{ item.product }}</strong> {{ money.convertAndFormat(item.unitPrice) }}</div> {% endfor %} <divclass="item"><strong>{{ 'sylius.ui.subtotal'|trans }}</strong>: {{ money.convertAndFormat(cart.itemsTotal) }}</div> </div> <ahref="{{ path('sylius_shop_cart_summary') }}"class="ui fluid basic text button">{{ 'sylius.ui.view_and_edit_cart'|trans }}</a> {% iftotal>=minimumOrderValue %} <divclass="ui divider"></div> <ahref="{{ path('sylius_shop_checkout_start') }}"class="ui fluid primary button">{{ 'sylius.ui.checkout'|trans }}</a> {% endif %} {% endif %} {{ sonata_block_render_event('sylius.shop.partial.cart.summary.after_popup_content', {'cart': cart}) }} </div>
Override templates (Sylius 1.7 only, skip this step for Sylius 1.6):
{# templates/bundles/SyliusAdminBundle/Channel/_form.html.twig #} {{ form_errors(form) }} <divclass="ui two column stackable grid"> <divclass="column"> <h4class="ui top attached large header">{{ 'sylius.ui.general'|trans }}</h4> <divclass="ui attached segment"> {{ form_errors(form) }} <divclass="fields"> <divclass="six wide field"> {{ form_row(form.code) }} </div> <divclass="seven wide field"> {{ form_row(form.name) }} </div> <divclass="three wide field"> {{ form_row(form.color) }} </div> </div> <divclass="ui hidden divider"></div> {{ form_row(form.enabled) }} </div> <divclass="ui attached segment"> <divclass="field"> {{ form_label(form.hostname) }} <divclass="ui labeled input"> <divclass="ui label">http://</div> {{ form_widget(form.hostname) }} </div> {{ form_errors(form.hostname) }} </div> {{ form_row(form.contactEmail) }} {{ form_row(form.description, {'attr': {'rows' : '3'}}) }} </div> <divclass="ui attached segment"> {{ form_row(form.countries) }} </div> <divclass="ui hidden divider"></div> <h4class="ui top attached large header">{{ 'sylius.ui.money'|trans }}</h4> <divclass="ui attached segment"> <divclass="two fields"> {{ form_row(form.baseCurrency) }} {{ form_row(form.currencies) }} </div> </div> <divclass="ui attached segment"> {{ form_row(form.defaultTaxZone) }} {{ form_row(form.taxCalculationStrategy) }} </div> </div> <divclass="column"> <h4class="ui top attached large header">{{ form_label(form.shopBillingData) }}</h4> <divclass="ui attached segment"> <divclass="two fields"> {{ form_row(form.shopBillingData.company) }} {{ form_row(form.shopBillingData.taxId) }} </div> <divclass="two fields"> {{ form_row(form.shopBillingData.countryCode) }} {{ form_row(form.shopBillingData.street) }} </div> <divclass="two fields"> {{ form_row(form.shopBillingData.city) }} {{ form_row(form.shopBillingData.postcode) }} </div> </div> <divclass="ui hidden divider"></div> <h4class="ui top attached large header">{{ 'sylius.ui.look_and_feel'|trans }}</h4> <divclass="ui attached segment"> {{ form_row(form.themeName) }} </div> <divclass="ui attached segment"> {{ form_row(form.locales) }} {{ form_row(form.defaultLocale) }} </div> <divclass="ui attached segment"> {{ form_row(form.menuTaxon) }} </div> <divclass="ui hidden divider"></div> <divid="nedac-sylius-minimum-order-value-plugin-admin-before"class="ui attached segment"> {{ form_row(form.skippingShippingStepAllowed) }} {{ form_row(form.skippingPaymentStepAllowed) }} {{ form_row(form.accountVerificationRequired) }} </div> {% ifform.minimumOrderValueisdefined %} <divid="nedac-sylius-minimum-order-value-plugin-admin-segment"class="ui segment"> {{ form_row(form.minimumOrderValue) }} <divclass="ui toggle checkbox"> <inputid="nedac-sylius-minimum-order-value-plugin-admin-toggle"type="checkbox"name="public"> <label>{{ 'nedac_sylius_minimum_order_value_plugin.ui.enabled'|trans }}</label> </div> </div> {% endif %} </div> </div>
{# templates/bundles/SyliusShopBundle/Cart/Summary/_checkout.html.twig #} {% import"@SyliusShop/Common/Macro/money.html.twig"asmoney %} {% setminimumOrderValue=cart.channel.minimumOrderValue %} {% settotal= sylius_order_items_subtotal(cart) %} {% iftotal>=minimumOrderValue %} {% setbuttonClass="ui huge primary fluid labeled icon button" %} {% else %} {% setbuttonClass="ui huge primary fluid labeled icon button disabled" %} {% setformattedMinimum= money.convertAndFormat(minimumOrderValue) %} {% setformattedDifference= money.convertAndFormat(minimumOrderValue-total) %} <divclass="ui icon negative message"> <iclass="warning icon"></i> <divclass="content"> <divclass="header">{{ 'nedac_sylius_minimum_order_value_plugin.ui.attention'|trans }}</div> <pid="nedac-sylius-minimum-order-value-plugin-message">{{ 'nedac_sylius_minimum_order_value_plugin.ui.minimum_not_yet_reached'|trans({ '%minimumOrderValue% ': formattedMinimum, '%difference%': formattedDifference })|raw('br') }}</p> </div> </div> {% endif %} <ahref="{{ path('sylius_shop_checkout_start') }}"class="{{ buttonClass }}"id="nedac-checkout-button"><iclass="check icon"></i> {{ 'sylius.ui.checkout'|trans }}</a>
{# templates/bundles/SyliusShopBundle/Cart/Widget/_popup.html.twig #} {% import"@SyliusShop/Common/Macro/money.html.twig"asmoney %} {% setminimumOrderValue=cart.channel.minimumOrderValue %} {% settotal= sylius_order_items_subtotal(cart) %} {% ifcart.empty %} {{ 'sylius.ui.your_cart_is_empty'|trans }}. {% else %} <divclass="ui list"> {% foritemincart.items %} <divclass="item">{{ item.quantity }} x <strong>{{ item.product }}</strong> {{ money.convertAndFormat(item.unitPrice) }}</div> {% endfor %} <divclass="item"><strong>{{ 'sylius.ui.subtotal'|trans }}</strong>: {{ money.convertAndFormat(cart.itemsTotal) }}</div> </div> <ahref="{{ path('sylius_shop_cart_summary') }}"class="ui fluid basic text button">{{ 'sylius.ui.view_and_edit_cart'|trans }}</a> {% iftotal>=minimumOrderValue %} <divclass="ui divider"></div> <ahref="{{ path('sylius_shop_checkout_start') }}"class="ui fluid primary button">{{ 'sylius.ui.checkout'|trans }}</a> {% endif %} {% endif %}
<divid="sylius-cart-button"class="ui circular cart button"> {{ sylius_template_event('sylius.shop.cart.widget.button', {'cart': cart}) }} </div> <divclass="ui large flowing cart hidden popup"id="nedac-sylius-minimum-order-value-plugin-popup"> {{ sylius_template_event('sylius.shop.cart.widget.popup', {'cart': cart}) }} </div>
Install assets:
bin/console sylius:install:assets
docker-compose build
docker-compose up -d
docker-compose exec php composer --working-dir=/srv/sylius install
docker-compose run --rm nodejs yarn --cwd=/srv/sylius/tests/Application install
docker-compose run --rm nodejs yarn --cwd=/srv/sylius/tests/Application build
docker-compose exec php bin/console assets:install public
docker-compose exec php bin/console doctrine:schema:create
docker-compose exec php bin/console sylius:fixtures:load -ndocker-compose exec php sh
bin/console doc:sche:cre
cd ../..
vendor/bin/phpcs
vendor/bin/phpstan analyse src/ --level max
vendor/bin/phpunit
vendor/bin/behat