From TYPO3Wiki

EXT: Event Database

Extension Key: rlmp_eventdb Copyright 2003-2005, rl@robertlemke.de, <rl@robertlemke.de>

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.com

Table of Contents

EXT: Event Database 1

Introduction 1

What does it do? 1

Key features 1

Live example 2

Sponsorship and donations 2

Installation 2

Basic setup and configuration 2

Overview 2

Preparations 3

Create categories and locations 3

Create events 3

TemplaVoila: Map the template 3

Classic templating 3

Insert and configure the frontend plugin 3

Advanced settings 3

Additional roles: agents and administrators 3

Customize notification and confirmation emails 3

Customize event data 3

Customize registration screens 3

Configure payment methods 3

Reference 3

Development 7

User's manual 7

Introduction 7

Creating categories 7

Creating locations 7

Creating events 7

Managing registrations 7

Managing payments 7

Appendix A: Upgrading from version 0.x.x 7

Introduction 7

Modify data structure 7

Installation 7

Appendix B: Payment 8

Introduction 8

Changelog 8

Introduction

What does it do?

This extension contains a frontend plugin for displaying re-ocurring events on your website. It was written for Tourismus-Service Scharbeutz, the touristic department of some small city at the Baltic Sea. Version 1.0.0 was a complete rewrite of the extension which adds much flexibilty and new features like registration and payment management for events. The event database extension supports two different templating methods, the classic and the TemplaVoila approach. It works with TYPO3 3.7.0 > and TemplaVoila 0.3.0 > and was cleanly coded according to the TYPO3 Coding Guidelines.

Important notice:
If you want to upgrade from an earlier version (below 1.0.0), please read the chapter Upgrading from version 0.x.x which contains important information.

Key features

These are the key features of rlmp_eventdb version 1.0.0:

• Intelligent support for TemplaVoila templating, detailed and highly customizable single views of events with sub menu items. Fallback mode for classic templating.
• Support for bookable events with configurable multi-step registration wizard
• Support for different payment methods and payment handling (based on paymentlib, requires PHP5)
• Flexform-based event records with many new properties, among them:
  event id, categories, location, description, pages / content elements containing more information, frequency and dates, registration enabled, term of registration, minimum / maximum participants, wait-list, freely configurable bookable features, payment methods, layout settings, email addresses for notifications, frontend user handling plus 5 customizable fields.
• Frontend plugin with search-, list- and single view, each configurable by the plugin options dialog or TypoScript.
• Single view with additional sub views, including registration and participant list
• Backend module with overview of events and registration / payment management
• Currently fully supporting German and English.

Live example

For a live working example, visit www.scharbeutz.de (section: Events, or german: Veranstaltungen). Note that usually there are more events in the german version than for the english speaking visitors.

Sponsorship and donations

Although a big part of the development has been paid by the Tourismus Service Scharbeutz, I invested almost double the time again in order to make this extension general and solid enough so others can also use it for their projects. If this extension helped you making a great website and you liked my work, please consider a donation to sponsor a part of the development already done. More information about sponsorship and the further development of this extension can be found at http://robertlemke.de/en/resources/extensions.html

Installation

The Event Database requires some other extensions to be installed. Just download and install the following extensions in the given order from the TYPO3 extension repository:

Important notice:
If you want to upgrade from an earlier version (below 1.0.0), please read the chapter Upgrading from version 0.x.x which contains important information. These extensions are neccessary for a basic installation. If you want to use the payment features for registration handling, please have a look at the appendix Payment.

Basic setup and configuration

Overview

This section describes a basic setup of the event database. Generally you have to decide if you want to use TemplaVoila or the classic templating approach before setting up this extension, both methods are supported but TemplaVoila offers more flexibility and is easier to use. If TemplaVoila is installed, it will be used automatically.

Preparations

Additional roles: agents and administrators

'plugin.tx_rlmpeventdb properties: TS configuratio'n

  confirmationPopupHeaderInclude = FILE
  confirmationPopupHeaderInclude.file = myHeader.html

  template = FILE
  template.file = EXT:rlmp_eventdb/res/confirmation-mail.txt

  template = FILE
  template.file = EXT:rlmp_eventdb/res/notification-mail.txt

  features {
     infoText.current = 1
     infoText.wrap = | 


  }

  address {
     infoText = 
     infoText.wrap = | 


  }

   address {
      fieldList = *first_name, *last_name, home_street, home_zip, home_city, home_country, tel_home1_voice, email
   }

  paymentmethod {
     infoText.current = 1
     infoText.wrap = | 


  }

  remarks {
     infoText = 
     infoText.wrap = | 


  }

  overview {
     infoText.current = 1
     infoText.wrap = | 


  }

[tsref:plugin.tx_rlmpeventdb]

Development

This section contains documentation for the development of the event extension itfself, but it might also be interesting for others.

User's manual

Introduction

Appendix A: Upgrading from version 0.x.x

Introduction

READ THIS SECTION '''BEFORE''' INSTALLING THE NEW VERSION! As mentioned, version 1.0.0 was a major overhaul of the event database extension which includes many new features and some changes in the data structure as well as the TypoScript. This section gives you a step-by-step guideline how you can upgrade to version 1.x.x and keeping your existing data from earlier versions.

Modify data structure

Before upgrading or installing the new version of the rlmp_eventdb extension, the table / field structure has to be modified a bit. Just go to phpMyAdmin or your favourite SQL client and execute this SQL query: ALTER TABLE `tx_rlmpeventdb_events` CHANGE `location` `locationid` INT(11) UNSIGNED DEFAULT '0' NOT NULL;
ALTER TABLE `tx_rlmpeventdb_events` CHANGE `shortdescription` `name` tinytext NOT NULL;
ALTER TABLE `tx_rlmpeventdb_events` CHANGE `description` `teasertext` text NOT NULL;

Installation

Now you are ready to install (i.e. upgrade) the rlmp_eventdb extension with the Extension Manager. A bunch of new fields and tables will be created, just confirm this creation as it won't overwrite any of your existing data. After successful installation you should enter the install tool, go to the “Database Analyzer” section, choose “compare” and drop the fields which are not used anymore: [FIXME: Screenshot install tool]

After installing the new version you have

Next steps:

- Edit all frontend plugins (because now uses flexforms)

Appendix B: Payment

Introduction

The event database offers an integration of the extension paymentlib. By using these features you will be able to offer different payment methods for the registration of your events. You may choose for each event separately which payment methods are available and if payment is required at all. To enable payment functionality you have to install the Payment Code Library (paymentlib) and at least one payment implementation which supports a specific payment provider. Please refer to the paymentlib manual how to install and configure the different extensions.

Changelog

Version 0.x.x to 1.0.0

• • Basically a complete rewrite! Now supports all modern features like FlexForms, database abstraction etc.
  • !!! Fields events.remarks, events.description and events.picture will not be displayed anymore and won't be supported in the future. Instead we now use content elements and pages.
  • !!! The tt_content fields for configuring categories and display mode for the frontend plugin are replaced by flexforms. That means you will have to edit each “Insert Plugin” content element where you use the event database and update configuration (which you want to do anyways).
  • Because too many labels changed, I deleted the Finnish and Swedish translation so we get a clean start.