thelia / wire-transfer-module
Package info
github.com/thelia-modules/WireTransfer
Type:thelia-module
pkg:composer/thelia/wire-transfer-module
Requires
- thelia/installer: ~1.1
README
Authors: Thelia info@thelia.net, Franck Allimant, franck@cqfdev.fr
Contents
fr_FR:
- Installation
- Utilisation
- Boucle
- Intégration
en_US:
- Install notes
- How to use
- Loop
- Integration
fr_FR
Ce module permet à vos clients de payer leurs commandes par virement banciare.
Il s'agit d'une amélioration du module PaymentTransfer.
Installation
Pour installer le module de paiement par virement, téléchargez l'archive et décompressez la dans <dossier de thelia>/local/modules
Utilisation
Tout d'abord, activez le module dans le Back-Office, onglet "Modules", puis cliquez sur "Configurer" sur la ligne du module.
Via la page de configuration, entrez vos informations bancaires et enregistrez.
Email de notification de paiement
Un email de notification de paiement est envoyé à vos clients lorsque vous avez bien reçu leur virement, et que leur commande passe à l'état payé. Le contenu de ce mail est configurable dans le back-office -> Configuration -> Template e-mail -> Confirmation de virement
Boucle
-
Le type de la boucle est
wiretransfer.get.info. Cette boucle permet de récupérer les informations bancaires.-
Arguments:
- order_id | obligatoire | id de la commande
-
Sorties:
- $ACCOUNT_HOLDER_NAME: nom du titulaire du compte
- $IBAN: Numéro IBAN
- $BIC: code BIC
-
Utilisation:
{loop name="wiretransfer.infos" type="wiretransfer.get.info" order_id=$placed_order_id} <dt>{intl d='wiretransfer' l="Account holder name"} : </dt> <dd>{$ACCOUNT_HOLDER_NAME}</dd> <dt>{intl d='wiretransfer' l="IBAN"} : </dt> <dd>{$IBAN}</dd> <dt>{intl d='wiretransfer' l="BIC code"} : </dt> <dd>{$BIC}</dd> {/loop}
-
Intégration
Les informations bancaires du commerçant sont affichées sur la page order-placed.html du template frontOffice standard,
en utilisant le hook order-placed.additional-payment-info.
en_US
This module offers wire transfer payment to your customers.
This is an improvement of the TranferPayment module.
Install notes
To install the wire transfer payment module, download the archive and uncompress it in <path to thelia>/local/modules
Usage
You first need to activate the module in the Back-Office, tab "Modules". Then click on "Configure" on the line of the module.
Using module's the configuration page, enter you Bank account information and save.
Payment notification e-mail
A notification email is sent to your customers when you've received their wire transfer, and switcher the order to the "paid" status.
The content of this e-mail could be configured in the back-office -> Le contenu de ce mail est configurable dans le back-office -> Configuration -> Mailing templates -> Wire transfer confirmation
### Loop
-
The loop type is
wiretransfer.get.info. This loop returns the bank information.-
Arguments:
- order_id | mandatory | id of the order
-
Output:
- $ACCOUNT_HOLDER_NAME: name of the bank account holder
- $IBAN: IBAN number
- $BIC: BIC code
-
Usage:
{loop name="wiretransfer.infos" type="wiretransfer.get.info" order_id=$placed_order_id} <dt>{intl d='wiretransfer' l="Account holder name"} : </dt> <dd>{$ACCOUNT_HOLDER_NAME}</dd> <dt>{intl d='wiretransfer' l="IBAN"} : </dt> <dd>{$IBAN}</dd> <dt>{intl d='wiretransfer' l="BIC code"} : </dt> <dd>{$BIC}</dd> {/loop}
-
Integration
The bank account information are displayed in order-placed.html file of the default front office template,
using the order-placed.additional-payment-info hook.
Thelia 3 (version 2.3.0+)
À partir de la 2.3.0, le module est Thelia 3 uniquement (branche main, Symfony 7.4, PHP 8.3,
Flexy). Le support Thelia 2 a été retiré : pour Thelia 2.5, utilisez la ligne 2.1, maintenue sur la
branche thelia2. As of 2.3.0 the module is Thelia 3 only; use the 2.1 line (branch thelia2)
for Thelia 2.5.
Rendu des surfaces / Where each surface lives
-
Back-office : la page de configuration est rendue via le hook
WireTransfer\Hook\Back\ConfigurationHook(module.configuration, déclaré pargetSubscribedHooks(), donc auto-découvert —Config/config.xmln'a plus de section<hooks>), templatetemplates/backOffice/default-twig/WireTransfer/module-configuration.html.twig. -
Front-office : Thelia 3 a supprimé les hooks Smarty du front sans remplacement fonctionnel —
ThemeHookInterfaceet le tagthelia.theme_hookexistent, mais rien ne consomme le tag et aucune fonction Twigtheme_hook()n'est enregistrée. Les coordonnées bancaires sont donc exposées par une fonction Twig :{{ wiretransfer_bank_info(order_id) }}Elle ne rend rien si la commande n'a pas été payée par virement. Le markup est construit par
WireTransfer\Service\WireTransferBankInfoRenderer, qui est la seule barrière d'échappement — le message configuré par le marchand est volontairement rendu brut. -
Routes : déclarées par attributs
#[Route]sur le contrôleur.Config/routing.xmla été supprimé : Thelia 3 le charge encore mais en émettant une dépréciation, et cumuler les deux mécanismes enregistrait la route en double. Chemin inchangé (/admin/wiretransfer/configure), nom de route inchangé (wiretransfer.configure). -
Traductions : les libellés front vivent désormais dans le domaine racine du module (
wiretransfer,I18n/en_US.phpetI18n/fr_FR.php) et non plus danswiretransfer.fo.default. Ce domaine-là n'existait que parce que Thelia le construit en scannanttemplates/frontOffice/*: supprimer le dossier Smarty aurait désenregistré le catalogue.
Boucle wiretransfer.get.info
Toujours disponible et inchangée : elle retourne ACCOUNT_HOLDER_NAME, IBAN, BIC, MESSAGE
pour un order_id. Sous Flexy, préférez la fonction Twig wiretransfer_bank_info() ci-dessus, qui
encapsule cette logique — la boucle n'a plus de consommateur dans le module.