EXT: Registrations for calendar events¶

General overview¶

The very popular TYPO3 extension “Calendar Base” (“cal”) provides a nice calendar, showing all types of events in several possible calendar displays. The extension “register4cal” adds a registration functionality to the calender events. Users can register and unregister for events. A maximum number of attendees can be set for events and a waitlist can be used if this number has been reached.

Userdefined fields for registrations¶

Several sets of userdefined fields can be defined and displayed in the registration form. This provides a very flexible way to obtain additional data from the attendees. Possible field types include text fields, multiline text areas as well as selection boxes. Fields are fully configurable from the TYPO3 backend and can be arranged in fieldsets. Every event can either use no fields, a configured default fieldset or an individual fieldset. Changing fields or fieldsets will not affect already stored registrations.

Registration in single event view and event list view¶

This extension supports the registration from the single event view as well as from the event list view. While the single event view shows the registration form below the event display, the event list view has a box attached to each event, including a checkbox to allow the user to register or unregister for the event.

Email confirmation and notification¶

Every change in a registration can cause a confirmation being sent to the user which registered for the event. Also, a notification can be send to the organizer(s) of the event if a registration has been changed.

Registration display¶

Besides from showing registration records in the backend, this extension provides a frontend-plugin which can display registrations in two ways:

• An event view, where frontend-users can see the events, they have registered for.
• An participant view, where event organizers can see the users which have registered for their events

Foreign user registration¶

Event organizers can be enabled to register/unregister foreign users for their events. This enables the organizers to manage all attendees for their events via this extension, even if the registration has been communicated via other ways than the website.

Frontend editing¶

This extensions fully supports the frontend editing features of the cal extension. It provides modified cal default templates, showing how to include the additional event fields into an additional tab of the cal frontend editing view.

Supporting extensions¶

The following extensions can be used together with this extension:

• rlmp_dateselectlib: Provides a date selection for the register4cal fields when using calendar event frontend editing.
• onetimeaccount: Enables users to create a temporary frontend user account to register for events.

Basic settings (register4cal)¶

FE-Editing (register4cal)¶

Compatibility to old templates (register4cal)¶

Activate registration¶

Field set¶

Registration start¶

Registration end¶

Maximum number of attendees¶

Activate waitlist¶

Assigning organizers to the event¶

Besides from the registration specific fields, the organizer setting of the event is important, if the organizer should be able to see registrations for this event in the frontend. On the Organizer tab, there are two possibilities to assign the organizer, if the Organizer Textfield has not been hidden as described in the Installation section. If you assign a Calender Event Organizer record, the fronent users, linked to that record, will be able to see the registrations for this event. Do not use the Organizer Textfield, if you wish to use this functionality.

Illustration 10: Assigning an organizer to an event

The Calendar Base extension provides the possibility to hide the Event Organizer Textfield. It is recommended that you do this. Please refer to the description in the Installation section on how to do this.

If cal is configured to use the Calendar Base Organizer data model¶

If cal is configured to use the build in Calendar Base Organizer data model organizers are stored as separate records. In order to allow frontend users to see registrations for events for which they are the organizers, it's additionally important to link Calender Event Organizers and Frontend Users. This can be done in the Calender Event Organizer records of the Calendar Base extension. This extension adds an additional field to the record:

Illustration 11: Link Calendar Event Organizers and Frontend Users/Groups

In this field you can select Website user and Website usergroup records and assign them to the organizer. If such an Calender Event organizer has been asigned to a Calender Event, these users can see who registered for an event and may use additional administrational functions for the event.

If cal is configured to use Frontend Users as organizer data model¶

In this case nothing needs to be configured. Register4cal will automatically recognize the setting and show the relevant events if the frontend user is logged on.

Language¶

Name¶

Caption¶

Type¶

Options(Selectionbox)¶

Default value(all field types)¶

Width(all field types)¶

Height(Mutliline Textfield)¶

Height(Selectionbox)¶

Field contains number of participants(Simple Textfield)¶

Name¶

Fields¶

Default field set¶

Even though I activated the registration feature, the single event view does not show the registration form.¶

Check if you are inside the registration period. Check if a frontend user has logged on

The registration form is being displayed well in the single event view, but the event list view does not show the registration possibility.¶

Read the section on enabling list view registration. Some changes need to be done in the list view templates to activate registration in event list view.

My user-defined field is not being shown in the registration form.¶

Did you include your user-defined field into a field set? Did you include it in the field set used for the registration for this event?

What happens if I change a field or field set after it has been used for a registration?¶

Nothing. Existing registrations will not be affected by changes on fields or field sets. For new registrations always the current definition of fields/field sets is being used.

I need an additional field type for my user-defined fields, how can I set it?¶

Currently it is not possible to define additional field types (except from modifying this extensions coding). If you have a good reason to add another field type, write an email and I'll see what I can do.

Marker for submit button¶

The marker ###MODULE__tx_register4cal_submit### inserts the submit button for the registration form. It should be added in the list template (default: EXT:cal/template/list/tmpl) in subpart “###LIST_TEMPLATE###”. The marker can be added twice to show the button both button on top and below the event list. Please notice the double underscore in the marker name after “MODULE”.

<!-- ###LIST_TEMPLATE### begin -->

<!-- ###PAGEBROWSER### begin -->
<p class="pagebrowser">
###PAGEOF###  ###PAGES###  ###PREVIOUS### ###NEXT###
</p>
<!-- ###PAGEBROWSER### end -->

<h1>###HEADING###</h1>
###FOUND###
<!-- ###PRE_LIST_TEMPLATE### begin -->
###MODULE__tx_register4cal_submit###
<dl>
<!-- ###PRE_LIST_TEMPLATE### end -->
     <!-- ###LIST### start -->
     <!-- ###LIST### end -->
<!-- ###POST_LIST_TEMPLATE### begin -->
</dl>
###MODULE__tx_register4cal_submit###
<!-- ###POST_LIST_TEMPLATE### end -->

<!-- ###PAGEBROWSER### begin -->
<p class="pagebrowser">
###PAGEOF###  ###PAGES###  ###PREVIOUS### ###NEXT###
</p>
<!-- ###PAGEBROWSER### end -->

###CREATE_EVENT_LINK###
<!-- ###LIST_TEMPLATE### end -->

Marker for registration box¶

The marker “###MODULE_tx_register4cal_listreg” (notice the doule underscore after “MODULE”) inserts the registration box for each event. It needs to be added to the event template (default: EXT:cal/template/phpicalendar_event.tmpl, since Calendar Base 1.3.0 EXT:/cal/template/event_model.tmpl). There are several subparts for event display to which the marker should be added:

• ###TEMPLATE_PHPICALENDAR_EVENT_LIST_ODD###
• ###TEMPLATE_PHPICALENDAR_EVENT_LIST_EVEN###
• ###TEMPLATE_PHPICALENDAR_EVENT_LIST_ODD_ALLDAY###
• ###TEMPLATE_PHPICALENDAR_EVENT_LIST_EVEN_ALLDAY###

<!-- ###TEMPLATE_PHPICALENDAR_EVENT_LIST_ODD### start -->
     <dt>
             <!-- ###EVENT_LINK### start-->###IMAGE### ###TITLE###<!-- ###EVENT_LINK### end--><br />
             ###STARTDATE### ###ENDDATE### <span class="V9G">###STARTTIME### ###ENDTIME###</span><br />
             ###MODULE__tx_register4cal_listreg###
             <br /><span class="V9G">###CATEGORY_LINK###</span>
     </dt>
     <dd>###DESCRIPTION###</dd>
<!-- ###TEMPLATE_PHPICALENDAR_EVENT_LIST_ODD### end -->

Example templates for Calendar Base¶

This extension contains modified templates for Calendar Base for the event list view. From version 1.4.0 on, cal contains a new set of templates, called “Standard”. The previously used templates are still contained and called “Classic”. The extension register4cal contains adapted templates for both the standard and the classic templates. These files can be found in EXT:register4cal/templates/cal_standard and EXT:register4cal/templates/cal_classic.

With some lines of TypoScript, you can use the template files from this folder, where the required markers for registration in event list view have been added already.

plugin.tx_cal_controller.view {
    list.listTemplate = EXT:register4cal/templates/cal_standard/list.tmpl
    event.eventModelTemplate = EXT:register4cal/templates/cal_standard/event_model.tmpl
}

Adding static template¶

All TypoScript settings, related to Calendar Base frontend editing have been put into the static template “FE-Editing (register4cal)”. Ensure you have included this static template to your TypoScript template(s), so that the settings will be taken into account.

IMPORTANT: If you have other additional fields defined for Calendar Base frontend editing, you need to combine these settings manually with the settings of this extension.

Template files to modify¶

There are two templates which need to be modified. Please ensure that you add all markers to both files, as otherwise the fields wont work for frontend editing.

Markers for registration related fields¶

The following markers can be used on the templates. Please notice the double underscore after “MODULE” and the upper/lower case of the markers

Create an own tab for the registration related fields¶

To create an own tab for the registration related fields for Calendar Base frontend editing, the fields should not be added to the fields inside an existing tab. Instead a new div section has to be created whose id has to be numbered consecutively to the existing div sections.

<div id="sc7" class="tabcontent">
     ###MODULE__tx_register4cal_activate###
     ###MODULE__tx_register4cal_regstart###
     ###MODULE__tx_register4cal_regend###
     ###MODULE__tx_register4cal_maxattendees###
     ###MODULE__tx_register4cal_waitlist###
     ###MODULE__tx_register4cal_fieldset###
</div>

plugin.tx_cal_controller.view {
    create_event.tabbedMenu {
     7 = TEXT
     7.dataWrap = <li><a href="" rel="sc7"><b>Registration</b></a></li>
    }
    edit_event.tabbedMenu {
     7 = TEXT
     7.dataWrap = <li><a href="" rel="sc7"><b>Registration</b></a></li>
    }
}

{LLL:EXT:register4cal/locallang_db.xml:tx_cal_event.tx_register4cal_tablabel}

Using rlmp_dateselectlib¶

This extension supports the extension rlmp_dateselectlib for front end editing. With rlmp_dateselectlib a date selector can be added to the “Start/End of registration period” fields. If you want to activate this feature perform the following steps:

• Ensure the rlmp_dateselectlib extension is installed
• Set the TypoScript setting plugin.tx_register4cal.edit.useDateSelector to 1
• Configure the date selector in TypoScript section plugin.tx_register4cal.edit.calConf. The settings in this section are taken from the rlmp_dateselectlib extension, therefore please refer to the manual of rlmp_dateselectlib for further details on these settings

By default, the use of rlmp_dateselectlib is activated in this extension, so that the only task would be to install rlmp_dateselectlib.

Example templates for Calendar Base¶

This extension contains modified templates for Calendar Base for frontend editing. These files can be found in EXT:register4cal/templates/cal_standard and EXT:register4cal/templates/cal_classic. If you are using a Calendar Base version less than 1.4.0, use cal_classic. For version from 1.4.0 on, use cal_classic if you are using the “Classic” templates from Calendar Base and cal_standard for the “Standard” templates from Calendar Base.

With some lines of TypoScript, you can use the template files from this folder, where the required markers for frontend editing have been added already.

plugin.tx_cal_controller.view {
    create_event.template = EXT:register4cal/templates/cal_standard/create_event.tmpl
    edit_event.template = EXT:register4cal/templates/cal_standard/create_event.tmpl
    confirm_event.template = EXT:register4cal/templates/cal_standard/confirm_event.tmpl
    create_event.tabbedMenu {
     7 = TEXT
     7.dataWrap = <li><a href="" rel="sc7"><b>{LLL:EXT:register4cal/locallang_db.xml:tx_cal_event.tx_register4cal_tablabel}</b></a></li>
    }
    edit_event.tabbedMenu {
     7 = TEXT
     7.dataWrap = <li><a href="" rel="sc7"><b>{LLL:EXT:register4cal/locallang_db.xml:tx_cal_event.tx_register4cal_tablabel}</b></a></li>
    }
}

Login using an existing account¶

To login with an existing account, usually the TYPO3 system extension felogin is being used. You need to set the following TypoScript parameters, which reside in the “plugin.tx_register4cal_pi1” section:

Create an one-time account¶

This option requires the extension onetimeaccount to be setup and configured as described in it's manual.

In addition the following TypoScript parameters need to be set, which also reside in the “plugin.tx_register4cal_pi1” section:

Displaying event-related fields¶

Usually, no event-related fields are contained in the message, telling the user that he needs to log in. It may be required to show such fields (e.g. the number of free places).

In this case you can add the relevant markers (for example ###MAXATTENDEES###, ###NUMATTENDEES###, ###NUMWAITLIST### oder ###NUMFREE###) in template section ###SINGLE_NEEDLOGIN###.

.enable¶

.onlyAfterRegistration¶

.includeOwnRegistration¶

.includeWaitlist¶

.includeCancelled¶

As this function may lead to questions related to data privacy, every user can decide whether his data should be visible for other users or not during registration. For this purpose an additional checkbox will be displayed in the registration form if this functionality is activated. Other users get to see the data only, if the user ticked this checkbox. Differing from this the organizer of the event can see all registered users.

To configure the displayed data the section “OTHER_USERS_LIST” is available in the template, which encloses the complete List. Inside this section “OTHER_USER” encloses a single registration from another user. Inside this sections all markers available in the registration form can be used. It only needs to be considered, that all markers in this sections relate to the registration of the other user.

Though the checkbox to confirm that other users may see the registration is being displayed in the listview registration form, the list of other registrations is not supported there.

.enable¶

.typeNum¶

.filename¶

.fieldmapping¶

Assignment of table fields to vcard fields¶

Inside the section “fieldmapping” in the vCard settings you can define, which table fields will be used for which fields in the vCard file. You can use fields from different tables, using for the registration:

plugin.tx_register4cal_pi1.vcardParticipant.fieldmapping {
        uid = USER_uid
        fullname = USER_name
        title = USER_title
        firstname = USER_first_name
        lastname = USER_last_name
        additionalnames = USER_middle_name
        nameprefix =
        namesuffix =
        nickname = USER_username
        birthday =
        organization = USER_company
        department =
        subdepartment =
        role =
        revision =
        geolocation =
        mailer =
        timezone =
}

plugin.tx_register4cal_pi1.vcardParticipant.fieldmapping {
        phonenumbers {
                0 = USER_telephone
                0 {
                       PREF = 0
                        WORK = 0
                        HOME = 1
                        OTHER = 0
                        VOICE = 1
                        FAX = 0
                        MSG = 0
                        CELL = 0
                        CAR = 0
                }
                1 = USER_fax
                1 {
                        PREF = 0
                        WORK = 0
                        HOME = 1
                        OTHER = 0
                        VOICE = 0
                        FAX = 1
                        MSG = 0
                        CELL = 0
                       CAR = 0
                }
        }
        emails {
                0 = USER_email
                0 {
                        INTERNET = 0
                        HOME = 1
                        WORK = 0
                        OTHER = 0
                        PREF = 0
                }
        }
        urls {
                0 = USER_www
                0 {
                        WORK = 0
                        HOME = 1
                        OTHER = 0
                        PREF = 0
                }
        }
}

plugin.tx_register4cal_pi1.vcardParticipant.fieldmapping {
        addresses {
                0 {
                        postofficeaddress =
                        extendedaddress =
                        street = USER_address
                        city = USER_city
                        zip = USER_zip
                        country = USER_country
                        type {
                                DOM = 0
                                INTL = 0
                                POSTAL = 0
                                PARCEL = 0
                                HOME = 1
                                WORK = 0
                        }
                }
        }
}

General settings¶

Foreign user registrations¶

Settings related to the registration of foreign users by event organizers can be found in section “plugin.tx_register4cal_pi1.foreignUserRegistration”.

“need to login” form¶

Settings related to the form, informing visitors that they need to login can be found in section “plugin.tx_register4cal_pi1.needLoginForm”.

Sending emails¶

Settings related to emails sent from this extension can be found in section “plugin.tx_register4cal_pi1.emails”.

Vcard files with participant or organizer information¶

Settings related to vCardfiles containing the participant information can be found in section “plugin.tx_register4cal_pi1.vcardParticipant”.

Settings related to vCardfiles containing the organizer information can be found in section “plugin.tx_register4cal_pi1.vcardOrganizer”.

Both sections have the same structure.

Configuring output¶

All views can be configured via TypoScript in the “plugin.tx_register4cal_pi1.forms” section. There is a subsection for every form, allowing the configuration of this form.

Data from event, location, organizer and user tables¶

All fields from tables containing event, location, organizer and user data can be used via markers.

Any other markers and labels¶

If for an marker “LABEL_*” no definition can be found, the text for object “label_*” from the language file EXT:register4cal/view/locallang.xml will be used.

If for an marker * no definition could be found, it is checked if a property with the same name (but lowercase) exists in the TypoScript section for the form. If this is the case, this property will be used as wrap for the marker.

Texts used from TypoScript¶

Mosts texts in the forms are directly set in TypoScript using the following form of TypoScript coding:

plugin.tx_register4cal_pi1.[something].dataWrap = {LLL:EXT:register4cal/view/locallang.xml:[text_name]}

To change such texts, just replace the default value from the TypoScript template your new text:

plugin.tx_register4cal_pi1.[something].dataWrap = [new text]

If you are familiar with Typo3 language files, and need to change a lot of texts, you may also create your own language file and use it instead of the default file. Using this method eases the changes for multilanguage sites. Conditions, changing texts for each language differently are not required. Only one value needs to be changed in TypoScript:

plugin.tx_register4cal_pi1.[something].dataWrap = {LLL:path/to/your/locallang.xml:[text_name]}

Texts used from Coding¶

Other texts, which are used from the coding, can be changed by adding substitution texts in TypoScript setup. To change a text, add the following line to your TypoScript coding:

plugin.tx_register4cal_pi1._LOCAL_LANG.[language].[text_name] = [new text]

Where [language] is the language, in which the text should be changed (e. g. „default“ for english, „de“ for german). [text_name] is the name of the text to be changed and [new text] is the new text.