bpp_pay Payment Plugin
bpp_pay 1.11rc7 - 18 June 2021
Copyright Jadefusion July 2012
Accept donations and online payments for bills, invoices, memberships and so on with this plugin. It can be used for almost any payment that does not have to automatically reoccur... The plugin will embed either a donation form, a payment form or a single buy now button into your web page.
Contents
Preamble
The bpp_pay Payment Plugin is used to place a form into your web page to enable you to accept online payments via PayPal.
Disclaimer: There are no warranties or support whatsoever with this plugin. You use it at your own risk!
Requirements: A working CMSimple-XH installation.
Back to contents
Installation instructions
- Unpack the bpp_pay archive file to a local folder on your computer, do not change the predefined folder structure.
- Using your FTP program, upload the folder bpp_pay and it's contents to the folder called plugins on your web server.
- Set the minimum permissions for the payment plugin folder.
folder name |
chmod |
config |
755 |
help |
755 |
languages |
755 |
images |
755 |
- The config folder contains the configuration file (config.php) which holds all plugin related configuration settings.
Set the config.php file permissions to 666 (chmod 666)
- In the help folder you will see the help file.
- Any logo and button images if needed are kept in the images folder.
- The languages folder contains the language files.
Set the language file permissions to 666 (chmod 666)
Note: Only English has been included with this release... english (en.php)
Please feel free to translate the plugin messages into your own language.
The bpp_pay Payment Plugin is now installed.
Before you can use the plugin to accept payments you must...
- Configure the plugin in the plugins Configuration settings.
- Integrate the plugin into a CMSimple page or into the template.htm
file.
Back to contents
Configuration Settings
The configuration settings of the bpp_pay payment plugin are integrated into the CMSimple administrative module. So, first login into this module.
Select bpp_pay from the list of available plugins.
Select the Configuration tab. You will find here the settings for...
- add donation:
If set true, a donation form will be added.
If set false, and a payment form will be added instead.
- add item payment:
If set true, just a payment button will be added with the item name and price embedded in the button.
If set false, and a payment form will be added instead.
- add top text donation - add top text payment:
If set true, text from the language settings will be shown at the top of the form.
If set false, only the form will be shown.
- btn plain donation - btn plain payment :
If set true, a standard submit button is used by the form as defined by the template you are using.
If set false, an image is used as a submit button.
- btn ext image donation - btn ext image payment :
If set true, an external image is used as a submit button.
If set false, an image from the plugin images folder is used as a submit button.
- btn img name donation - btn img name payment :
The name of the image from the plugin images folder to be used by the plugin as a submit button.
- btn url donation - btn url payment:
Either the full url to the form submit button if you are using an external image for it... eg: http://www.yoursite.xyz/images/button.gif
or the relatve address of it, if it is on your own website
eg: images/button.gif
- currency:
The international currency code used to set payment currency
AUD : Australian Dollars
EUR : Euro
USD : US Dollars
- payment donation name:
Enter a name for the donation eg: Donation for yoursite.xyz
- payment for:
Enter your PayPal email address
- payment item name:
The name of the item you want payment for. If displaying a full payment form rather than just a payment button, this can be left blank.
- payment item price:
The item price. If displaying a full payment form rather than just a payment button, this can be left blank.
- submit text donation - submit text payment:
Title on the button if you use a standard submit button and not an image.
Back to contents
Language Settings
The language settings of the bpp_pay payment plugin are integrated into
the CMSimple administrative module. So, first login into this module.
Select bpp_pay from the list of available plugins.
Select the Language settings tab. Here are the settings for...
- donation add top text - payment add top text
Text to be added at the top of the form.
- menu main
Heading in administration for the plugin 'main' tab
- menu css
Heading in administration for the plugin 'stylesheet' tab
- menu config
Heading in administration for the plugin 'configuration' tab
- menu language
Heading for the administration for the plugin 'language' tab
- menu help
Heading in administration for the plugin 'help' tab
- donation amount text - payment amount text
Text heading for the text box where you enter the payment amount.
- donation amount hint - payment amount hint
Shown as you hover over the payment amount text box with a mouse.
- payment title text
Text heading for the text box where the payment description is entered. Not displayed for donations.
- payment title hint
Shown as you hover over the text box where the payment description is entered with a mouse. Not displayed for donations.
Change the language settings according to your needs and use the save button to save the modifications you make.
Back to contents
Integration into a CMSimple page
The bpp_pay payments form is called by means of a special function called : bpp_pay().
If you want to show a bpp_pay payments form in a CMSimple page, follow the steps listed below:
Login into the CMSimple administration module
- Select 'edit mode'
- Select the page you want the PayPal payments form to appear or just create a new page
- Change your editor to html mode, and use one of the methods shown below...
- With CMSimple-XH the following code can be used to insert the payment form anywhere within a CMSimple generated page.
<div>{{{plugin:bpp_pay();}}}</div>
- You can also use CMSimple scripting... When you do, the payment form will always be the last item placed on the page.
<div>#cmsimple $output.=bpp_pay();#</div>
- Change your editor to back to 'normal mode', and save the page changes.
- Test that the bpp_pay payments plugin is working by navigating to the page containing your bpp_pay payments form.
You can now accept Donations and Payments online...
Back to contents
Integration into a CMSimple site template
To display a bpp_pay payment form within your template, follow the steps listed below:
Login into the CMSimple administration module
Select either settings or setup from the CMSimple admin menu and select edit template from System files list.
- Add the following php script into the template code in the location you want the payment form to appear...
<?php echo bpp_pay();?>
- Save your template modification.
- Verify that the bpp_pay payment form appears on the site.
Back to contents