EXT: Donations¶

What does it do?¶

This extension is designed to collect donations on a web site, either for specific projects or in a general way. Using payment extensions (see Installation below) donations can be collected using on-line payment solutions.

Although perfectly functional this is still a work in progress so you may have trouble fitting it exactly to your needs. See the To Do List below for details on missing features and future developments.

Screenshots¶

No single screenshot can really sum up what this extension does. Please browse this manual, many screenshots are included. In particular, you may want to refer to the “Donation process” part of the “Users manual” chapter for an overview.

Credits¶

This extension was originally created by Tonni Aagesen. Much of the code is still his as well as the application logic so many thanks go to him. His work got me very nicely kickstarted.

The icons used in this extension come from the Silk Icons library ( http://www.famfamfam.com/lab/icon/silk/ ), a beatiful set of icons developed under the Creative Commons license by Mark James, of Birmingham, UK.

Questions and support¶

If you have questions about this extension please ask them in the general mailing list, so that everyone can benefit from the answers. If you find a bug or want to submit a feature request, use the dedicated bug tracker on the project's home page: http://forge.typo3.org/projects/show/extension-donations.

Installation¶

This extension requires a few other extensions for working properly:

Payment Library (paymentlib), for on-line payment

Money Library (moneylib), for formatting currency display

Static Info Tables (static_info_tables), for information about currencies

It also requires PHP 5 to run because of its dependency on paymentlib.

In itself Payment Library is not enough. An implementation for a specific payment gateway is necessary, like paymentlib_ipayment or paymentlib_quickpay.

Setup¶

After installing the extension several steps must be taken before it can to work correctly.

Static template

First of all it is necessary to include the static setup template.

Projects

If projects are to be used, then at least one must be defined in the TYPO3 backend. Create a new record in the backend and choose the type “Projects”.

It is not necessary to fill out all the fields, but at least a title and an amount must be entered. The amount is the total quantity of money that needs to be raised for the project.

TypoScript setup

A number of properties can be set via TypoScript, besides the defaults found in the static template. However, one setup is absolutely necessary: the definition of the payment methods that will be used for the donations. Without that, it will be impossible to perform donations.

The static template contains a list of payment methods (the “paymethods” property) that correspond to the paymentlib_offline extension. This is just an example and serious values should definitely be set for this property.

Please refer to the TypoScript Reference below.

Templates

An example template is provided with the donations extension (pi1/example.tmpl). Copy it and transform it according to your needs, without forgetting to change the “template” property in the TypoScript setup accordingly.

Content element

Last but not least, a content element for donations must be inserted in the page where the donations process is going to take place.

First choose the type “Insert plugin”, then choose the plugin “Donations”. The starting point is optional. If defined, only projects found in the selected page will be displayed in the list. If not, all projects will be displayed.

You should now be able to go through a complete donation process, as detailed next.

Donation process¶

A complete example donation process is described here so that every step can be properly understood. Sample screenshots are shown where appropriate.

List of projects

When projects are used, this is the default view. It lists all projects available for donation. If projects are not being used, this view will never appear (it redirects to the donation view). Projects whose maximum amount has already been reached do not appear in this list.

Project details

This view displays all the details about a single project. It is reached by clicking on the details link of the list view above. If projects are not being used, this view will never appear (it redirects to the donation view). It is possible to go back to the projects list.

Donation view

This page displays the form where the donation data is entered: payment information, personal data and donation amount. The payment information comes directly from paymentlib and depends on the installed and configured payment gateways. From here, it is possible either to proceed with the payment or to go back to the projects list.

Confirmation view

The confirmation view displays the data entered in the previous step for validation before the payment process is launched. It also checks the input values and redirects to the donation view in case of errors. In such a case, the donation view is called with an error code and displays the appropriate error message.

Receipt view

If the online payment is successful the user is sent to the receipt view (if it fails, the user is redirect to the confirm view with an error message). This view does not only display a visual confirmation of success, it also stores the donation in the database and sends e-mails as configured.

Mails

If so configured, the donations extensions can send an e-mail both to the donator and to the site administrator. These e-mails are simple text mails, with donation information listed according to the chosen template.

TypoScript Reference¶

Template¶

A template is used to format the output of the donations extension. It is comprised of several views which are detailed below along with their respective markers.

List view (###LISTVIEW###)

This produces a list of all the projects available for donation.

0.6.0¶

0.5.0¶

0.0.1¶

EXT: Donations - 12