#5490 Manual plugin

Parent Category:: DPCalendar

Category:: Payment plugins

Last Updated:: Allon Moritz, Monday, 27 May 2024 08:33

Created:: Wednesday, 06 August 2014 03:31

Hits:: 5286

This feature is part of the DPCalendar Standard subscription.

SubscribePHP 7.4PHP 8Joomla 3.10Joomla 4.4Joomla 5

Introduction

The manual payment plugin can be used for any kind of offline payment, for example cash or through wire. The booking itself has the state On hold, when not changed in the settings, as soon as the user has finished the booking process. This means the web site admin needs to manually activate the booking when the payment has arrived on the bank account.

Configure the plugin

The DPCalendar manual plugin allows to add unlimited bank accounts or other information options to DPCalendar. When the plugin is opened in the back end, then you can click on the "+" button to add a new configuration. There you can fill the following fields:

ID
The ID of the configuration, must be a unique integer amongst the different configurations within the plugin.
Title
The title of the configuration. Appears in the drop down in the event form where you can select individual payment providers.
Description
The description which will be shown on the front end provider selection list when confirming the booking.
Icon
The icon which will be shown on the front end provider selection list when confirming the booking.
Status
The publishing status of the payment provider.
Payment Date
The date till when the payment must be done. Can be an absolute date like 2022-08-18 or relative like '-2 days'.
Send invoice
A flag to define if the invoice should be sent or not during the booking process.
Booking status
The status the booking should have when the booking process is finished.
Payment statement
The payment statement is used in the invoice and contains bank information.

Invoice

The invoice is sent out as soon as the attendee has selected the manual payment provider and clicks on the confirm button. The invoice is rendered from the file /plugins/dpcalendarpay/manual/tmpl/invoice.php, means the site admin can do a layout override, when some adaptions are needed.

A special parameter in the invoice is the "bankInformation" parameter which contains the payment statement text from the payment provider configuration. The DPCalendar PDF options like header, logo or address are used in the invoice as well to be inline with the other system generated PDF files.

The subject of the mail is created from the language string "PLG_DPCALENDARPAY_MANUAL_INVOICE_SUBJECT_TEXT" and the message from "PLG_DPCALENDARPAY_MANUAL_INVOICE_MESSAGE_TEXT". The available variables are explained below.

Payment statement

The payment statement contains information how to transfer the money to the organizer. This text is used in the invoice. Initially the text is built from the language variable PLG_DPCALENDARPAY_MANUAL_PAYMENT_STATEMENT_TEXT, this offers the possibility to use different strings per language. The language string can be overridden in the Joomla language manager. If you have only one language in use, you can change the text of the plugin directly in the wysiwyg editor while configuring the plugin in the back end.

Variables

We are using the mustache templating system to inject and render variables in the language strings as described in the Output rendering article. Means you can use a variable like {{price}} in the string and it will be replaced with the real value. For every language string below are the following variables available:

id
The id of the booking.
uid
The uid of the booking.
price
The price of the booking.
email
The email address of the attendee.
country
The country address of the attendee.
province
The province address of the attendee.
city
The city address of the attendee.
zip
The zip address of the attendee.
street
The street address of the attendee.
number
The number address of the attendee.
telephone
The telephone address of the attendee.
currency
The currency of the price in the booking.
currencySymbol
The currency symbol of the price in the booking.
bankInformation
The bank information from the statement.
paymentDueDate
The date when the payment must arrive.
invoiceDetails
The text from the invoice.
bookingDetails
The details of the booking.
field-[*]
The booking custom fields objects. You can directly access every field with the prefix field- and then the name. For example when the field has the name XYZ, you can use the way {{#field-XYZ}}{{value}}{{/field-XYZ}} to render the value of it.