PayPlug payment plugin for Sylius

This plugin allows you to integrate PayPlug payment with Sylius platform app including payment features and refunding orders.

Requirements

In the channel settings, the base currency must be set to EUR because the payment gateway only works in this currency.

In local environment, the plugin will not work properly because you will not be notified of the status of payments from the payment gateway.

⚠️ To generate "Credit memos" when refunding, your server need to have the WKHTMLTOPDF binary ⚠️

More info in refund-plugin documentation.

❗️Known issues about refund-plugin❗️

• #234 - [UI/UX] Refund float price : Decimals seperated by comma are taken into account.

Installation

1. If you don't use symfony/messenger component yet, it is required to configure one of the message buses as a default bus in file config/packages/framework.yaml:

   framework:
       messenger:
           default_bus: sylius_refund_plugin.command_bus

2. As this plugin has a dependency to sylius/refund-plugin which does not yet have a stable release, configure your project to accept release candidate version.

   composer config minimum-stability rc
   composer config prefer-stable true

3. Require the payplug/sylius-payplug-plugin :

   composer config extra.symfony.allow-contrib true
   composer require payplug/sylius-payplug-plugin

4. Copy and apply migrations

   Update config/packages/doctrine_migrations.yaml by adding following config

   doctrine_migrations:
       migrations_paths:
           ...
           'DoctrineMigrations': "%kernel.project_dir%/src/Migrations"

   Copy migrations from vendor/payplug/sylius-payplug-plugin/src/Migrations/ to your migrations directory (e.g. src/Migrations) and apply them to your database

   cp -R vendor/payplug/sylius-payplug-plugin/src/Migrations/* src/Migrations
   bin/console doctrine:migrations:migrate

5. Copy templates that are overridden by Sylius into templates/bundles/SyliusAdminBundle

   mkdir -p templates/bundles/SyliusAdminBundle/
   cp -R vendor/payplug/sylius-payplug-plugin/src/Resources/views/SyliusAdminBundle/* templates/bundles/SyliusAdminBundle/

6. Add PayPlug to refundable payment method for Sylius Refund Plugin in config/services.yaml

   parameters:
       sylius_refund.supported_gateways:
           - payplug
           - payplug_oney

7. Add PayPlug routes in config/routes.yaml

   sylius_payplug:
      resource: "@PayPlugSyliusPayPlugPlugin/Resources/config/routing.yaml"

8. Process translations

   php bin/console translation:update en PayPlugSyliusPayPlugPlugin --dump-messages
   php bin/console translation:update fr PayPlugSyliusPayPlugPlugin --dump-messages

9. Clear cache:

   php bin/console cache:clear

🎉 You are now ready to add Payplug Payment method. In your back-office, go to Configuration > Payment methods, then click on Create and choose "PayPlug".

Logs

If you want to follow the logs in the production environment, you need to add the configuration in config/packages/prod/monolog.yaml, logs should be in var/log/prod.log which can be searched after the phrase [Payum] or [PayPlug]:

  monolog:
      handlers:
         ...
         
         payum:
             level: debug
             type: stream
             path: "%kernel.logs_dir%/%kernel.environment%.log"

Customization

Available services you can decorate and forms you can extend

Run the below command to see what Symfony services are shared with this plugin:

$ bin/console debug:container payplug_sylius_payplug_plugin

Template overriding

This plugin override some sylius templates. If you plan override them also, you should retrieve them in your application.

Copy Sylius templates overridden in plugin to your templates directory (e.g templates/bundles/)

 mkdir -p templates/bundles/SyliusAdminBundle/
 mkdir -p templates/bundles/SyliusShopBundle/
 cp -R vendor/payplug/sylius-payplug-plugin/src/Resources/views/SyliusAdminBundle/* templates/bundles/SyliusAdminBundle/
 cp -R vendor/payplug/sylius-payplug-plugin/src/Resources/views/SyliusShopBundle/* templates/bundles/SyliusShopBundle/
 ```

## Testing

```bash
$ composer install
$ cd tests/Application
$ yarn install
$ yarn build
$ bin/console assets:install public -e test
$ bin/console doctrine:database:create -e test
$ bin/console doctrine:schema:create -e test
$ bin/console server:run 127.0.0.1:8080 -d public -e test
$ open http://localhost:8080
$ bin/behat
$ bin/phpspec run

License

This library is under the MIT license.

Oney Integration

For better Oney integration, you can check the Oney enhancement documentation.

Doc

• Development
• Release Process