Skip to content

Latest commit

 

History

History
155 lines (114 loc) · 4.94 KB

README.md

File metadata and controls

155 lines (114 loc) · 4.94 KB
Raw

Payment Fee Plugin

Features

  • Charge extra fee for a payment method
  • Typical usage: Cash on Delivery
  • Taxes are implemented the same way as taxes for shipping fees

Installation

  1. Run composer require 3brs/sylius-payment-fee-plugin

  2. Add plugin class to your config/bundles.php

    return [
   ...
   ThreeBRS\SyliusPaymentFeePlugin\ThreeBRSSyliusPaymentFeePlugin::class => ['all' => true],
];

  3. Your Entity PaymentMethod has to implement \ThreeBRS\SyliusPaymentFeePlugin\Model\PaymentMethodWithFeeInterface. You can use Trait ThreeBRS\SyliusPaymentFeePlugin\Model\PaymentMethodWithFeeTrait.

For guide how to use your own entity see Sylius docs - Customizing Models

Admin

  1. Include @ThreeBRSSyliusPaymentFeePlugin/Admin/_form.html.twig into @SyliusAdmin/PaymentMethod/_form.html.twig.
{# ... #}

{% include '@ThreeBRSSyliusPaymentFeePlugin/Admin/_form.html.twig' %}
  1. Include @ThreeBRSSyliusPaymentFeePlugin/Admin/_order_show.html.twig into @AdminBundle/Order/Show/Summary/_totals.html.twig.
{# ... #}

{% include '@ThreeBRSSyliusPaymentFeePlugin/Admin/_order_show.html.twig' %}

Shop

  1. Include @ThreeBRSSyliusPaymentFeePlugin/Shop/Checkout/SelectPayment/_choice.html.twig into @ShopBundle/Checkout/SelectPayment/_choice.html.twig.
{# ... #}

{% include '@ThreeBRSSyliusPaymentFeePlugin/Shop/Checkout/SelectPayment/_choice.html.twig' %}
  1. Add variable fee {% set fee = form.method.vars.payment_costs[choice_form.vars.value] %} into @ShopBundle/Checkout/SelectPayment/_payment.html.twig into foreach.
{# ... #}

{% for key, choice_form in form.method %}
    {% set fee = form.method.vars.payment_costs[choice_form.vars.value] %}
    {% include '@SyliusShop/Checkout/SelectPayment/_choice.html.twig' with {'form': choice_form, 'method': form.method.vars.choices[key].data} %}
{% else %}
    {% include '@SyliusShop/Checkout/SelectPayment/_unavailable.html.twig' %}
{% endfor %}
  1. Include @ThreeBRSSyliusPaymentFeePlugin/Shop/Common/Order/Table/_payment.html.twig into @ShopBundle/Common/Order/Table/_totals.html.twig.
{# ... #}

<tr>
    {% include '@SyliusShop/Common/Order/Table/_shipping.html.twig' with {'order': order} %}
</tr>
{% include '@ThreeBRSSyliusPaymentFeePlugin/Shop/Common/Order/Table/_payment.html.twig' with {'order': order} %}
  1. Create and run doctrine database migrations 
    bin/console doctrine:migrations:diff
bin/console doctrine:migrations:migrate

Development

Usage

  • Alter plugin in /src
  • See bin/ dir for useful commands

Testing

After your changes you must ensure that the tests are still passing.

composer install
bin/console doctrine:database:create --if-not-exists --env=test
bin/console doctrine:schema:update --complete --force --env=test
yarn --cwd tests/Application install
yarn --cwd tests/Application build

bin/behat
bin/phpstan.sh
bin/ecs.sh
vendor/bin/phpspec run

Opening Sylius with your plugin

  1. Install symfony CLI command: https://symfony.com/download
    • hint: for Docker (with Ubuntu) use Debian/Ubuntu — APT based Linux installation steps as root user and without sudo command
      • you may need to install curl first apt-get update && apt-get install curl --yes
  2. Run app
(cd tests/Application && APP_ENV=test bin/console sylius:fixtures:load)
(cd tests/Application && APP_ENV=test symfony server:start --dir=public --port=8080)
  • change APP_ENV to dev if you need it

License

This library is under the MIT license.

Credits

Developed by 3BRS
Forked from manGoweb.