README

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.

⚠️ Refunds requirements

You need to make some adjustments in order to make our plugin worked normally due to a dependency to refund-plugin. Please follow those requirements:

To generate "Credit memos" when refunding, your server need to have the WKHTMLTOPDF binary as explain in refund-pluging documentation # Pre-requirements

Compatibility

Installation

Require the payplug/sylius-payplug-plugin :

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

Apply migrations to your database:
```
bin/console doctrine:migrations:migrate
```

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/

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

parameters:
    locale: fr_FR
    sylius_refund.supported_gateways:
        - payplug
        - payplug_oney
        - payplug_bancontact
        - payplug_apple_pay
        - payplug_american_express

Add Payplug routes in config/routes.yaml

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

Add Traits for Customer and PaymentMethod entities

App\Entity\Customer\Customer

<?php

declare(strict_types=1);

namespace App\Entity\Customer;

use Doctrine\ORM\Mapping as ORM;
use PayPlug\SyliusPayPlugPlugin\Entity\Traits\CustomerTrait;
use Sylius\Component\Core\Model\Customer as BaseCustomer;

/**
* @ORM\Entity
* @ORM\Table(name="sylius_customer")
*/
#[ORM\Entity]
#[ORM\Table(name: 'sylius_customer')]
class Customer extends BaseCustomer
{
   use CustomerTrait;
}

App\Entity\Payment\PaymentMethod

<?php

declare(strict_types=1);

namespace App\Entity\Payment;

use Doctrine\ORM\Mapping as ORM;
use PayPlug\SyliusPayPlugPlugin\Entity\Traits\PaymentMethodTrait;
use Sylius\Component\Core\Model\PaymentMethod as BasePaymentMethod;
use Sylius\Component\Payment\Model\PaymentMethodTranslationInterface;

/**
 * @ORM\Entity
 * @ORM\Table(name="sylius_payment_method")
 */
#[ORM\Entity]
#[ORM\Table(name: 'sylius_payment_method')]
class PaymentMethod extends BasePaymentMethod
{
    use PaymentMethodTrait;

    protected function createTranslation(): PaymentMethodTranslationInterface
    {
        return new PaymentMethodTranslation();
    }
}

App\Entity\Payment\Payment

<?php

declare(strict_types=1);

namespace App\Entity\Payment;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ORM\Mapping as ORM;
use PayPlug\SyliusPayPlugPlugin\Entity\Traits\PaymentTrait;
use Sylius\Component\Core\Model\Payment as BasePayment;

/**
* @ORM\Entity
* @ORM\Table(name="sylius_payment")
*/
#[ORM\Entity]
#[ORM\Table(name: 'sylius_payment')]
class Payment extends BasePayment
{
   use PaymentTrait;
}

Process translations

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

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/
mkdir -p templates/bundles/SyliusUiBundle/
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/
cp -R vendor/payplug/sylius-payplug-plugin/src/Resources/views/SyliusUiBundle/* templates/bundles/SyliusUiBundle/

You also need to edit your twig config to add your path to avoid our configuration to be prepended :

twig:
  paths:
    '%kernel.project_dir%/templates/bundles/SyliusAdminBundle': SyliusAdmin
    '%kernel.project_dir%/templates/bundles/SyliusShopBundle': SyliusShop
    '%kernel.project_dir%/templates/bundles/SyliusUiBundle': SyliusUi

Development

See How to contribute.

License

This library is under the MIT license.

Oney Integration

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

payplug / sylius-payplug-plugin

Maintainers

Details