payplug/sylius-payplug-plugin

PayPlug payment plugin for Sylius applications.

Installs: 1 792

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 11

Forks: 9

Open Issues: 0

Type:sylius-plugin


README

License CI Version Total Downloads

68747470733a2f2f64656d6f2e73796c6975732e636f6d2f6173736574732f73686f702f696d672f6c6f676f2e706e67

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❗️

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. Import custom form row theme in your config/packages/twig.yaml file:

    twig:
        ...
        form_themes: [
            'form/form_gateway_config_row.html.twig'
        ]
  5. Copy custom form row theme template

    mkdir -p templates/form/
    cp -R vendor/payplug/sylius-payplug-plugin/src/Resources/views/form/* templates/form/
  6. 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
  7. 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/
  8. Add PayPlug to refundable payment method for Sylius Refund Plugin in config/services.yaml

    parameters:
        sylius_refund.supported_gateways:
            - payplug
  9. Process translations

    php bin/console translation:update en PayPlugSyliusPayPlugPlugin --dump-messages
    php bin/console translation:update fr PayPlugSyliusPayPlugPlugin --dump-messages
  10. 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

Testing

$ 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.

Doc