Login / Status
developer.Resource
Home . Documentation . Document Library . Extension Manuals
Sponsors
hosted by punkt.deTYPO3 and Open Source MagazineAOE Media

1.5. Reference

There are two sections in TS setup that contain setting for this extension: plugin.tx_seminars and plugin.tx_seminars_pi1.

Setup common for front-end plug-in and back-end module in plugin.tx_seminars

You can configure the plug-in using your TS template setup in the form plugin.tx_seminars.property = value. The values in this table can only be configured using your TypoScript setup, but not via flexforms.

Property:

Data type:

Description:

Default:

isStaticTemplateLoaded

boolean

Do not touch this variable! This is needed for checking whether the static template has been included correctly.

1

enableRegistration

boolean

Set this to 0 if you don't use the registration feature for this site and would like to disable the configuration check for this.

1

templateFile

string

File name of the HTML template for e-mail

EXT:seminars/seminars.tmpl

salutation

string

switch whether to use formal/informal language for some shared code (in e-mails, some labels and some error messages).Allowed values are:formal | informal

formal

charsetForEMails

string

The charset used for e-mails to the organizers and the attendees; should match the charset used in the BE and FE (this is usually UTF-8 or ISO-8859-1).

UTF-8

hideFieldsInThankYouMail

string

comma-separated list of section names that shouldn't be displayed in the thank-you e-mail to the user

allowed values are in: hello, title, uid, ticket_id, price, seats, total_price, attendees_names, lodgings, foods, checkboxes, kids, accreditation_number, credit_points, date, time, place, room, additional_times_places, paymentmethod, billing_address, url, footer

credit_points,billing_address,kids

generalPriceInMail

boolean

whether to use the label “Price” for the standard price (instead of “standard price”) in e-mail to the participant

hideFieldsInNotificationMail

string

Comma-separated list of section names from the registration that shouldn't be displayed in the notification e-mail to the organizers. These fields are the big blocks in that e-mail, and some are further divided.

Allowed values are in:

  1. hello: a short message that someone has signed up

  2. summary: the attendee's name, the event title and the event date

  3. seminardata: date from the seminar record, configurable via showSeminarFieldsInNotificationMail

  4. feuserdata: data from the front-end user record, configurable via showFeUserFieldsInNotificationMail

  5. attendancedata: data from the attendance record, configurable via showAttendanceFieldsInNotificationMail

showSeminarFieldsInNotificationMail

string

comma-separated list of field names from seminars that should be mentioned in the notification e-mail to the organizers (in the “seminardata” section)allowed values are in: uid, event_type, title, subtitle, titleanddate, date, time, accreditation_number, credit_points, room, place, speakers, price_regular, price_regular_early, price_special, price_special_early, attendees, allows_multiple_registrations, attendees_min, attendees_max, vacancies, enough_attendees, is_full, notes

title,uid,event_type,date,place,price_regular,price_regular_early,price_special,price_special_early,attendees,vacancies,enough_attendees,is_full

showFeUserFieldsInNotificationMail

string

comma-separated list of field names from fe_users that should be mentioned in the notification e-mail to the organizers  (in the “feuserdata” section)allowed values are all column names from fe_users.

username,name,email,address,zip,city,telephone,tx_seminars_phone_mobile

showAttendanceFieldsInNotificationMail

string

comma-separated list of field names from attendances that should be mentioned in the notification e-mail to the organizers  (in the “attendancedata” section)allowed values are in: uid, interests, expectations, background_knowledge, lodgings, accommodation, foods, food, known_from, notes, checkboxes, price, seats, total_price, attendees_names, kids, method_of_payment, gender, name, address, zip, city, country, telephone, email

uid,price,seats,total_price,method_of_payment,gender,name,address,zip,city,country,telephone,email,interests,expectations,background_knowledge,known_from,notes

sendAdditionalNotificationEmails

boolean

Whether to send the additional notification e-mails to the organizers or not. Additional notification mails are sent if for example an event gets full.

1 (= active)

sendNotification

boolean

Whether to send a notification to the organizers if a user has registered.

1 (= active)

sendNotificationOnUnregistration

boolean

Whether to send a notification to the organizers if a user has unregistered.

1 (= active)

sendNotificationOnRegistrationForQueue

boolean

Whether to send a notification to the organizers if someone registered for the queue.

1 (= active)

sendNotificationOnQueueUpdate

boolean

Whether to send a notification to the organizers if the queue has been updated.

1 (= active)

sendConfirmation

boolean

Whether to send a confirmation to the user after the user has registered.

1 (= active)

sendConfirmationOnUnregistration

boolean

Whether to send a confirmation to the user if the user has unregistered.

1 (= active)

sendConfirmationOnRegistrationForQueue

boolean

Whether to send a confirmation to the user if the user has registered for the queue.

1 (= active)

sendConfirmationOnQueueUpdate

boolean

Whether to send a confirmation to the user if the queue has been updated.

1 (= active)

timeFormat

string

the time format (in strftime format)

%H:%M

dateFormatY

string

the strftime format code to extract the year from a date string(usually this shouldn't be changed)

%Y

dateFormatM

string

the strftime format code to extract the month from a date string(usually this shouldn't be changed)

%m.

dateFormatD

string

the strftime format code to extract the day of month from a date string(usually this shouldn't be changed)

%d.

dateFormatYMD

string

the strftime format code for the full date(change this to your local date format)

%d.%m.%Y

dateFormatMD

string

the strftime format code for the month and day of month(change this to your local date format)

%d.%m.

abbreviateDateRanges

boolean

whether date ranges should be shortened when possible, for example

11.10.2005-13.10.2005 becomes 11.-13.10.2005

1

currency

string

ISO3 code of the currency to be used (XXX not used yet)(taken from the static_info_tables extension)

EUR

eventType

string

The default event type. This value will be used for events that have no type assigned to them.

Workshop

showTimeOfRegistrationDeadline

boolean

whether to also show the time of the registration deadline instead of just the date

0

showTimeOfEarlyBirdDeadline

boolean

whether to also show the time of the early bird deadline instead of just the date

0

showTimeOfUnregistrationDeadline

boolean

whether to also show the time of the unregistration deadline instead of just the date

0

unregistrationDeadlineDaysBeforeBeginDate

integer

Number of days before the start of an event until unregistration is possible. (If you want to disable this feature just leave the value empty.)

allowUnregistrationWithEmptyWaitingList

Boolean

Whether unregistration is possible even when there are no registrations on the waiting list yet.

0

showVacanciesThreshold

integer

If there are at least this many vacancies, “enough” (localized) is displayed instead of the exact number.

Set this to a number higher than the highest number of vacancies if you want the exact number to be always displayed.

10

decimalDigits

integer

number of digits after the point in event prices

2

thousandsSplitChar

string

the character used to split the thousands in event prices

decimalSplitChar

string

the character used to split the price and its decimal digits

.

showToBeAnnouncedForEmptyPrice

boolean

whether events that have no standard price set should have “to be announced” as price instead of “free”

0

allowAccessToCsv

boolean

Whether anyone can access the CSV export function without any checks. Enabling this will allow anyone to access sensitive data. Use this for testing purposes only!

0

charsetForCsv

string

the charset provided in the HTTP header for CSV export

utf-8

filenameForEventsCsv

string

the filename proposed for CSV export of event lists

events.csv

filenameForRegistrationsCsv

string

the filename proposed for CSV export of registration lists

registrations.csv

fieldsFromEventsForCsv

string

comma-separated list of field names from tx_seminars_seminars that will be used for CSV exportAllowed values are in:uid, tstamp, crdate, title, subtitle, teaser, description, event_type, accreditation_number, credit_points, date, time, deadline_registration, deadline_early_bird, place, room, lodgings, foods, additional_times_places, speakers, partners, tutors, leaders, price_regular, price_regular_early, price_regular_board, price_special, price_special_early, price_special_board, additional_information, payment_methods, organizers, attendees_min, attendees_max, attendees, vacancies, enough_attendees, is_full, cancelled

uid,title,subtitle,description,event_type,date,time,place,room,additional_times_places,speakers,price_regular,attendees,attendees_max,vacancies,is_full

fieldsFromFeUserForCsv

string

comma-separated list of field names from fe_users that will be used for CSV export

name,company,address,zip,city,country,telephone,email

fieldsFromAttendanceForCsv

string

comma-separated list of field names from tx_seminars_attendances that will be used for CSV export

uid,price,total_price,method_of_payment,gender,name,address,zip,city,country,telephone,email,interests,expectations,background_knowledge,known_from,notes

showAttendancesOnRegistrationQueueInCSV

boolean

wether to show attendances on the registration queue in the CSV export or not

0

attendancesPID

page_id

PID of the page (or system folder) where event registrations (attendances) will be stored

None

[tsref:plugin.tx_seminars]

Setup for the Seminar Manager front-end plug-in in plugin.tx_seminars_pi1

You can configure the plug-in using flexforms of the front-end plug-in (for most values) or your TS template setup in the form plugin.tx_seminars_pi1.property = value.

If your want to set a value for all instances of the plug-in in one place, use the TS template setup. If you use flexforms, make sure to set the values at all relevant instances of the plug-in: It doesn't do to specify the fields for the online registration in the seminar list front-end plug-in—you need to set these fields in the online registration front-end plug-in.

If you set any non-empty value in the flexforms, this will overwrite the TS template setup setting.

Property:

Data type:

Description:

Default:

isStaticTemplateLoaded

boolean

Do not touch this variable! This is needed for checking whether the static template has been included correctly.

1

enableRegistration

boolean

Set this to 0 if you don't use the registration feature for this site and would like to disable the configuration check for this.

1

numberOfClicksForRegistration

integer

number of clicks to registration (valid options are 2 or 3)

3

what_to_display

string

The kind of front-end plug-in to display. Allowed values are in: seminar_list, topic_list, my_events, my_vip_events, seminar_registration, list_registrations, list_vip_registrations, edit_event, my_entered_events, countdown, category_listThis must be set using flexforms.

seminar_list

templateFile

string

location of the HTML template for the FE plugin

EXT:seminars/pi1/seminars_pi1.tmpl

registrationEditorTemplateFile

string

location of the template file for the registration form

EXT:seminars/pi1/registration_editor.html

salutation

string

Switch whether to use formal/informal language on the front end.Allowed values are:formal | informal

formal

showSingleEvent

integer

The UID of an event record. If an event is selected, the plugin always shows the single view of this event and not the list.

This must be set using flexforms.

timeframeInList

string

the time-frame from which events should be displayed in the list view. Select one of these keywords:all, past, pastAndCurrent, current, currentAndUpcoming, upcoming, deadlineNotOver

currentAndUpcoming

hideColumns

string

comma-separated list of column names that shouldn't be displayed in the list view, e.g. organizers,price_special

The order of the elements in this list has no influence on the output.Allowed values are in: category, title, subtitle, uid, event_type, language, accreditation_number, credit_points, teaser, speakers, date, time, place, city, country, seats, price_regular, price_special, total_price, organizers, target_groups, vacancies,  status_registration, registration, list_registrations, editPlease note that some columns will only be shown if a front-end user currently is logged in.

category,subtitle,event_type,language,accreditation_number,credit_points,teaser,time,place,country,price_special,speakers,target_groups

hideFields

string

comma-separated list of field names that shouldn't be displayed in the detail view, e.g. organizers,price_special

The order of the elements in this list has no influence on the output.Allowed values are in: title, subtitle, language, description, accreditation_number, credit_points, category, date, uid, time, place, room, additional_times_places, speakers, partners, tutors, leaders, price_regular, price_board_regular, price_special, price_board_special, additional_information, target_groups, paymentmethods, target_groups, organizers, vacancies, deadline_registration, otherdates, eventsnextday, registration, back

credit_points,eventsnextday

hideSelectorWidget

boolean

whether to show the selector widget in the list view

1

hideSearchForm

boolean

whether to show the search form in the list view

0

hidePageBrowser

boolean

whether to show the page browser in the list view

0

hideCanceledEvents

boolean

whether to show canceled events in the list view

0

sortListViewByCategory

boolean

whether the list view should always be sorted by category (before applying the normal sorting)

0

generalPriceInList

boolean

whether to use the label “Price” as column header for the standard price (instead of “Standard price”)

0

generalPriceInSingle

boolean

whether to use the label “Price” as heading for the standard price (instead of “Standard price”) in the detailed view and on the registration page

0

omitDateIfSameAsPrevious

boolean

whether to omit the date in the list view if it is the same as the previous item's (useful if you often have several events at the same date)

0

eventFieldsOnRegistrationPage

string

list of comma-separated names of event fields that should be displayed on the registration page (the order doesn't matter)Allowed values are in: uid,title,accreditation_number,price_regular,price_special,vacancies

title,price_regular,price_special,vacancies

showRegistrationFields

string

comma-separated list of tx_seminars_attendances DB fields to show for the online registrationThe order of the values is not relevant. Allowed values are in:step_counter, price, method_of_payment, account_number, bank_code, bank_name, account_owner, billing_address, gender, name, address, zip, city, country, telephone, email, interests, expectations, background_knowledge, accommodation, food, known_from, seats, attendees_names, kids, lodgings, foods, checkboxes, notes, feuser_data, billing_address, registration_data, terms, terms_2

Note: billing_address enabled the summary of all billing address fields for the second registration page. To get this to work correctly, you also need to enable the particular fields for a separate billing addres that should be displayed on the first registration page, for example: name, address, zip, city

step_counter,price,method_of_payment,lodgings,foods,checkboxes,interests,expectations,background_knowledge,known_from,notes,feuser_data,billing_address,registration_data,terms_2

numberOfFirstRegistrationPage

integer

the displayed number of the first registration page (for "step x of y")

1

numberOfLastRegistrationPage

integer

the displayed number of the last registration page (for "step x of y")

2

showSpeakerDetails

boolean

whether to show detailed information of the speakers in the single viewif disabled, only the names will be shown

1

showSiteDetails

boolean

whether to show detailed information of the locations in the single viewif disabled, only the name of the locations will be shown

1

showFeUserFieldsInRegistrationsList

string

comma-separated list of FEuser fields to show in the list of registrations for an event

name

logOutOneTimeAccountsAfterRegistration

boolean

Whether one-time FE user accounts will be automatically logged out after they have registered for an event.

Note: This does not affect regular FE user accounts in any way.

1

baseURL

string

Base URL of your TYPO3 site (including the protocol and the trailing slash), e.g. http://www.mytypo3site.net/

pages

integer

PID of the sysfolder that contains the event records (e.g. the startingpoint)

None

recursive

integer

level of recursion that should be used when accessing the startingpoint

None

listPID

page_id

PID of the page that contains the seminar list

None

detailPID

page_id

PID of the page that contains the detailed view

None

myEventsPID

page_id

PID of the page that contains the "my events" list

None

registerPID

page_id

PID of the page that contains the seminar registration plug-in

None

thankYouAfterRegistrationPID

page_id

PID of the thank-you page that will be displayed after a FE user has registered for an event

None

sendParametersToThankYouAfterRegistrationPageUrl

boolean

Wether to send GET parameters to the thank-you-after-registration-page-URL.

1

pageToShowAfterUnregistrationPID

page_id

PID of the thank-you page that will be displayed after a FE user has unregistered for an event

None

sendParametersToPageToShowAfterUnregistrationUrl

boolean

Wether to send GET parameters to the thank-you-after-registration-page-URL.

1

loginPID

page_id

PID of the page that contains the login form

None

registrationsListPID

page_id

PID of the page that contains the registrations list for participants

None

registrationsVipListPID

page_id

PID of the page that contains the registrations list for VIPs

None

eventEditorFeGroupID

integer

UID of the FE user group that is allowed to enter and edit event records in the FE

None

defaultEventVipsFeGroupID

integer

UID of the FE user group that is allowed to see the registrations of all events

None

eventEditorPID

page_id

PID of the page where the plug-in for editing events is located

None

createEventsPID

page_id

PID of the sysfolder where FE-created events will be stored

None

eventSuccessfullySavedPID

page_id

PID of the page that will be shown when an event has been successfully entered on the FE

None

bankTransferUID

record_id

UID of the payment method that corresponds to "bank transfer", used for input validation in the registration form

None

externalLinkTarget

string

The target for external links in seminars.

None

[tsref:plugin.tx_seminars_pi1]

Setup for the list view

For the list view, there are some additional configuration option that can only be set using the TS setup in the form plugin.tx_seminars_pi1.listView.property = value. Those values can not be set via Flexforms.

Property:

Data type:

Description:

Default:

orderBy

string

The default sort order in list view. Allowed values are:category, title, uid, event_type, accreditation_number, credit_points, speakers, date, time, place, price_regular, price_special, organizers, vacancies

date

descFlag

boolean

whether to show the list view ordered in ascending (=0) or descending order (=1)

0

results_at_a_time

integer

The number of events that shall be displayed per page

20

maxPages

integer

the number of neighboring pages to list in the page browser

5

[tsref:plugin.tx_seminars_pi1.listView]

Constants for the Seminar-Manager front-end plug-in in plugin.tx_seminars_pi1

You can configure the plug-in using your TS template constant in the form plugin.tx_seminars_pi1.property = value.

Property:

Data type:

Description:

Default:

cssFile

string

location of the CSS file (set as empty to not include the file)

EXT:seminars/pi1/seminars_pi1.css

[tsref:plugin.tx_seminars_pi1]

Hooks

It is possible to extend the front-end part by using hooks in pi1/class.tx_seminars_pi1.php. Currently there's only one hook within pi1/class.tx_seminars_pi1.php which is called just before the markers of the single view get substituted. To use this hook you'll have to create a class with a method called "modifySingleView". The method in your class should only expect one parameter which is a reference to tx_seminars_pi1. Please contact us if you need additional hooks.