https://github.com/dvsa/mot-cpms-forms
Laminas module to provide re-usable HTML Forms that can be used by scheme to process payments.
https://github.com/dvsa/mot-cpms-forms
Last synced: 10 months ago
JSON representation
Laminas module to provide re-usable HTML Forms that can be used by scheme to process payments.
- Host: GitHub
- URL: https://github.com/dvsa/mot-cpms-forms
- Owner: dvsa
- Created: 2023-06-04T12:41:32.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T15:41:55.000Z (over 1 year ago)
- Last Synced: 2024-12-08T02:22:10.690Z (over 1 year ago)
- Language: PHP
- Size: 180 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CPMS Forms
## Introduction
A module to provide re-usable HTML Forms that can be used by scheme to process payments.
## Installation
### Main Setup
#### With composer
The recommended way to install is through [Composer](https://getcomposer.org/).
```
composer require dvsa/mot-cpms-forms
```
#### Post installation
1. Enable it in your application.config.php file.
```php
array(
// ...
'CpmsForms',
),
// ...
);
```
2. Copy configuration file to your autoload config folder (optional)
```bash
cp vendor/dvsa/mot-cpms-forms/config/cpms-forms.global.php.dist config/autoload/cpms-forms.global.php
```
## Usage
For payment form generation please use controller plugin:
```php
$form = $this->getCpmsPaymentForm($payment);
```
The plugin takes one argument, which must be an object that implements one of the following interfaces:
* CpmsForms\Payment\CardPaymentInterface
* CpmsForms\Payment\StoredCardPaymentInterface
* CpmsForms\Payment\DirectDebitPaymentInterface
* CpmsForms\Payment\CashPaymentInterface
* CpmsForms\Payment\ChequePaymentInterface
* CpmsForms\Payment\ChipPinPaymentInterface
* CpmsForms\Payment\PostalOrderPaymentInterface
As it might be obvious, payment interface determines required data, that needs to be provided by scheme and tells Form Factory Service to build specific for that interface form.
Each payment type always requires common information (amount, user id, etc.), so it's convenient to use ``CpmsForms\Payment\BasePaymentTrait`` trait in your payment classes.
The cpms-forms plugin validates post data and redirects to cpms-forms controller for processing. In regard to redirection, the proper usage should be:
```php
$form = $this->getCpmsPaymentForm($payment);
if ($form instanceof \Laminas\Http\Response) {
return $form;
}
```
The form should be passed to ViewModel and be rendered via view cpms-forms helper plugin:
```
renderCpmsForm($form); ?>
```
## Configuration
### View scripts
If custom view script is needed to render payment form, please add this in your configuration file:
```
[
'partials' => [
'form' => 'custom-path/custom-script.phtml',
],
],
];
```
It's also possible to provide view script for specific payment type:
```
return [
'cpms_forms' => [
'partials' => [
'form' => 'custom-path/custom-script.phtml',
'stored_card' => 'custom-path/stored-card-script.phtml',
],
],
];
```
### Form customization
Custom form class can be provided for specific payment type. This class must extends ``CpmsForms\Form\PaymentForm`` class to be considered as a valid.
See example:
```
return [
'cpms_forms' => [
'payment_types' => [
'direct_debit' => [
'form' => 'Scheme\Form\CustomDirectDebitPaymentForm'
],
],
],
];
```
Form elements can be also customized. The following example sets html class of ``mandate_collection_day`` element and adds e-mail field:
```
return [
'cpms_forms' => [
'payment_types' => [
'direct_debit' => [
'form_elements' => [
'mandate_collection_day' => [
'attributes' => [
'class' => 'form-control olcs-form-element',
],
],
[
'name' => 'email',
'attributes' => [
'type' => 'email',
'class' => 'form-control',
],
'options' => [
'label' => 'Customer E-mail',
'required' => true,
],
]
],
],
],
],
];
```
For more options, payment types and form elements please see ``config/module.config.php``
## Contributing
Please refer to our [Contribution Guide](/CONTRIBUTING.md).
TO DO
------------
* Check if client is authorized to use a payment type
* Implement event manager for pre and post payment actions
* Integrate CPMS Miscellaneous Payments Module