EXT: Agency Registration¶

What does it do?¶

The Agency Registration plugin is an improved variant of Kasper Skårhøj’s Front End User Admin extension. The German translation is ‘Büro Anmeldung’.

The Agency Registration extension features include:

• Use of standard TYPO3 facilities and tools: localization, alternate languages, character sets (utf-8 by default), TypoLink URLs, constant editor, default CSS in TypoScript setup;
• Use of country codes, country subdivision codes and language codes of the Static Info Tables;
• Addition of the following fields: gender, status, date of birth, comments, cnum (customer number), terms acknowledged and usergroup;
• Compatibility with extension “Direct Mail” 2.0 in the use of field ‘Receive HTML emails?’ (module_sys_dmail_html), ‘Receive newsletter?’ (module_sys_dmail_newsletter) and of “Direct Mail Categories” (module_sys_dmail_category);
• Sending HTML emails;
• Optional attachment to HTML confirmation emails;
• Optional use of email address as username;
• Optional selection of user group on registration;
• Optional administrative review process for approval of registrations;
• User upload and maintenance of a set of images;
• Validation of the user’s Internet site URL;
• Switching salutation mode;
• Sending an invitation to register;
• en_US localization;
• Compatibility with salted passwords (saltedpasswords) and RSA authentication (rsaauth);
• CSS-styled XHTML 1.0 Strict template;
• Seven optional hooks;
• Compatibility with extension Database Abstraction Layer (dbal).

Features in Version 0¶

Version 0:

• Requires TYPO3 4.4 - 6.1 and PHP 5.2 - 5.4.
• Supports salted passwords and RSA authentication: system extensions Frontend Login for Website Users (felogin), Salted user password hashes (saltedpasswords) and RSA authentication for TYPO3 (rsaauth) are for security reasons recommended to be installed; extension Salted user password hashes (saltedpasswords) should be configured to enable salted passwords in frontend (FE) in the EM of saltedpasswords (Enable FE [basic.FE.enabled]). In the TYPO3 Install Tool, frontend (FE) login security level should be checked if ‘normal’ is mentioned to be the default value. Otherwise it should be configured to ‘normal’, if using a SSL connection, or to ‘rsa’ otherwise ([BE][loginSecurityLevel] = rsa).
• Requires Static Methods since 2007 (div2007) 0.10.1+ to be installed.
• Adds a status report in Admin Tools->Reports (TYPO3 4.6+ only) to check for possible problems with the installation of the extension (required and conflicting extensions, login security level, salted passwords enablement).
• Removes all clear-text passwords: all occurrences of markers ‘###FIELD_password###’ and ‘###FIELD_password_again###’ should be removed from all html templates; label variable %5$s is now replaced by an empty string.
• In HTML template ###TEMPLATE_EDIT###, marker ###LABEL_PASSWORD### is replaced by ###LABEL_NEW_PASSWORD###.
• Invitation email does not provide a password: marker ‘###LABEL_V_REGISTRATION_INVITED_MESSAGE1###’ should be replaced with marker ‘###LABEL_V_REGISTRATION_INVITED_MESSAGE1A###’ in all templates.
• Emails do not contain any clear-text password: marker ‘###LABEL_V_REGISTRATION_INFOMAIL_MESSAGE1###’ should be replaced with marker ‘###LABEL_V_REGISTRATION_INFOMAIL_MESSAGE1A###’ in all templates.
• On accepting an invitation, the user is prompted to choose a password: template subpart ###TEMPLATE_SETFIXED_OK_APPROVE_INVITE### must be added to the template file (see the default template file).
• Corrects the occurrences of subpart ###SUB_INCLUDED_FIELD_terms_acknowledged### in the default HTML template and adds the field terms_ acknowledged to the default form setup.
• Adds occurrences of subpart ###SUB_INCLUDED_FIELD_middle_name### in the default HTML template and adds field middle_name to the BE page view. However, the field is not added to the default setup.
• Adds new doNotEnforceUsername TS constant.
• Adds new userGroupsPidList TS constant.
• Adds new email.replyToAdmin TS setup property allowing to specify an alternate replyTo email address on mails sent to the user.
• Adds HTML template subpart ###TEMPLATE_CREATE_SAVED_REVIEW###: it is displayed when the user has created his account, email confirmation request is disabled, but administrative review is enabled.
• Adds support for itemsProcFunc property of TCA select and radio fields.
• Adds termsUrl TS constant and setup property.
• Adds support for ‘Receive newsletter?’ (module_sys_dmail_newsletter). Adds subparts ###SUB_INCLUDED_FIELD_module_sys_dmail_newsletter### to the default HTML template. A new TS constant and TS setup property ‘unsubscribeAllowedFields’, allows to specify a list of fields that may be updated, whithout the user having to login, by an UNSUBSCRIBE link from a newsletter mailing application. The following template subparts are added in support of this feature: ###TEMPLATE_SETFIXED_OK_UNSUBSCRIBE###, ###EMAIL_TEMPLATE_SETFIXED_UNSUBSCRIBE_HTML### and ###EMAIL_TEMPLATE_SETFIXED_UNSUBSCRIBE###.
• Modifies the occurrences of subpart ###SUB_INCLUDED_FIELD_captcha_response### in the default HTML template in order to use the same definition list structure as the other subparts of the forms.

Requirements¶

Agency Registration (extension key: agency) requires TYPO3 4.4+ and PHP 5.2+.

Version 0+ recommends the extensions Frontend Login for Website Users (felogin), Salted user password hashes (saltedpasswords) (which is required for autologin, password generation and MD5 encoding), RSA authentication for TYPO3 (rsaauth) (which is required under some curcumstances of auto-login) and it recommends Static Info Tables (static_info_tables) 2.3.0+, and it requires Static Methods since 2007 (div2007) 1.0.3+ to be installed.

Credits¶

Thanks to many contributors of code, testers and bug fixers. See the file contributors.txt for list of contributors to this extension: http://forge.typo3.org/projects/extension- agency/repository/entry/trunk/contributors.txt

Sponsors¶

Development of this extension was sponsored by Wild Wild Web , Webspinnerij , Alexander Maringer and many others.

You may sponsor further development of this extension by contacting Franz Holzinger .

Support¶

You can get support and installation service for this extension at http://www.jambage.com/kontakt/forum.html .

Please see or report bugs on TYPO3 Forge: http://forge.typo3.org/projects/show/extension-agency

Registration Process¶

The default procedure is the following:

• Just below the login box, the visitor is presented a link to a registration form or, if the user is already logged in, a link to a profile editing form;
• The first time visitor completes the registration form and clicks on the submit button. He is presented with a preview form in order to verify the registration information before creating the account. Hitting ‘Cancel’, he may go back to the form to make any desired correction; he will have to re-enter his password. Upon submitting the verified registration information, the new user is informed that an email is being sent to him to complete the registration process and his account is assigned to a user group preventing any special access;
• An email is sent to the registering visitor. The message contains two links. One link allows the visitor to confirm the registration and the other link cancels the registration (in case somebody has used his email address);
• Clicking on either link brings the visitor to a message page displayed in his browser. If he has confirmed his registration, he is presented with a login box and may log into the site. When the user confirms his registration, his account is assigned a user group allowing him to access whatever pages are targeted at registered users;
• When logged in, the user may edit his account information or delete his account;
• Upon each event (registration, confirmation, cancellation, update, or deletion), an email may be sent to the user to confirm the action. An email notification may also be sent to the administrator of the site. The email to the user may be in HTML format, if desired (the email will always include a plain text version).

Invitation¶

The extension may also be configured so that a front end user can create an account for another person and send an invitation to register. The invitation email allows the invited person to accept or decline the invitation. If the invited person accepts the invitation, she will be presented a form and requested to enter twice the same password. Consider to set enableAutoLoginOnInviteConfirmation to 1 if you want to enable this quick process. Otherwise you must send the invited person his password in the registration email or by other means.

Administrative Review¶

The extension may also be configured so that an email is sent to the site administrator when a visitor confirms his(her) registration.

In such case, the visitor is informed by email that his(her) registration needs to be reviewed and accepted by the site administration before he(she) may login.

The email sent to the site administrator contains all the information provided by the visitor (except the password). It also contains two links allowing the site administrator to accept or refuse the registration.

When the site administrator accepts or refuses the registration, an email is sent to inform the visitor of the decision of the site administration. The visitor may login only after the registration has been accepted by the site administrator.

The administrative review is bypassed when the registration was made by invitation.

Important¶

See topic ‘Language files’ how to get the translations for other languages. The language files must be imported separately in the Extension Manager.

It is highly discouraged to use the long urls because they contain risks in security. You should always have useShortUrls set to 1! This also facilitates the usage of RealUrl, and it shows much shorter links to the user.

For security reasons it is recommended to use the extensions saltedpasswords and rsaauth together with this extension. Otherwise the passwords will be stored in clear text and can be read and misused by hackers of TYPO3.

Migration from sr_feuser_register¶

If you have formerly used the Front End User Registration, then you can easily migrate to Agency Registration which started as a copy of it.

Create the folder uploads/tx_agency before you install agency for the first time.

Keep sr_feuser_register installed for a moment and install also agency. Ignore any conflicts warnings of the Extension Manager during the migration process.

Change the constants and setup from ‘p lugin.tx_srfeuserregister_pi1’ into ‘ plugin.tx_agency’ .Change the example template and CSS files from ‘EXT:sr_feuser_register/pi1/tx_srfeuserregister_htmlmail.css’ to ‘EXT:agency/template/tx_agency_htmlmail.css’

Change all the ‘Include static (from extensions)’ from ‘FE User Registration CSS-styled (sr_feuser_register)’ selections into ‘Agency Registration (agency)’.

Copy all files from ‘uploads/tx_srfeuserregister’ into ‘uploads/tx_agency’.

Change all your plugins of the ‘Front End User Extension’ into ‘Agency Registration’.

Deinstall sr_feuser_register.If you have forgotten to move some plugins, then you will see them like this:

Modify the HTML template file and CSS file.Replace ‘tx- srfeuserregister-pi1’ by ‘agency’ and ‘tx_srfeuserregister_pi1’ by ‘agency’.

Copy the localisation folder ‘/web/typo3conf/l10n/de/sr_feuser_register/’ into ‘/web/typo3conf/l10n/de/agency/’. Rename the pi1 subfolder to pi. Repeat this step for any other language which you need.

Install DirectMail, then add the new table fields in the EM or Install Tool and deinstall DirectMail again or leave it installed.

If you have written your TYPO3 extension which uses hooks, then change your hooks from$GLOBALS[‘TYPO3_CONF_VARS’][‘EXTCONF’][SR_FEUSER_RE GISTER_EXTkey][‘tx_srfeuserregister_pi1’][‘registrationProcess’][]i nto$GLOBALS[‘TYPO3_CONF_VARS’][‘EXTCONF’][AGENCY_EXT][‘registration Process’][]Notice that the array part «[‘tx_srfeuserregister_pi1’]» has been removed.

Front End Rendering¶

EXT:agency/template/agency_css_tmpl.html

plugin.tx_agency._CSS_DEFAULT_STYLE = @import url("fileadmin/styles/some_style_sheet_file.css");

plugin.tx_agency._CSS_DEFAULT_STYLE >

Localization¶

# language
   config.htmlTag_langKey = de
   config.language = de
   config.locale_all = de_DE
   config.sys_language_uid = 0

plugin.tx_agency._LOCAL_LANG.languageCode.labelName = overridingValue

plugin.tx_agency._LOCAL_LANG.languageCode.tableName.fieldName = overridingValue

plugin.tx_agency._LOCAL_LANG.languageCode.extraLabelName = extraLabelValue

Configuration steps¶

These are the steps to configuring the Agency Registration extension:

Install the extension using the Extension Manager. If not already installed, it is recommended that you install the extensions Frontend Login for Website Users (felogin), Salted user password hashes (saltedpasswords), RSA authentication for TYPO3 (rsaauth). And it is required that you install Static Info Tables (static_info_tables) 2.3.0+ and Static Methods since 2007 (div2007) 1.0.3+.If you want to use the fields of DirectMail, e.g. the checkbox to send HTML emails, then you must install DirectMail. Make sure to add the table fields for DirectMail. You can deinstall DirectMail afterwards.

If installed, the extension Salted user password hashes (saltedpasswords) should be configured to enable salted passwords in frontend (FE).

Using the TYPO3 Install Tool, frontend (FE) login security level should be configured to ‘normal’, if using an SSL connection, or to ‘rsa’ otherwise. When frontend (FE) login security level is configured to ‘rsa’, the page cannot contain multiple registration/login forms (see: http://forge.typo3.org/issues/34568 ).

The extension always uses character set utf-8 by default.

The extension supports the Swift Mailer API shipped with TYPO3 and also the old API; if using TYPO3 4.5 or TYPO3 4.6, you maybe want to set [‘MAIL’][‘substituteOldMailAPI’] to ‘1’ in the Install tool; with TYPO3 4.7+, the old API is not supported anymore.

Use the status report in Admin Tools->Reports (TYPO3 4.6+ only) to check for possible problems with the installation of the extension (required and conflicting extensions, login security level, salted passwords enablement).

Add the following static template to your TypoScript template: ‘Agency Registration’.

Create a folder page that will contain the records of front end users. Set the TS template constant pid to the page id of this folder. In the folder, create two Front End User Groups. Set the TS template constant userGroupUponRegistration to the uid of the first group and constant userGroupAfterConfirmation to the uid of the second group. The second group gives access to the pages targeted at the registered front end users, while the first group does not. If you use the generation of the user group from an XML file then the user groups will be filled in from uid values in the setfixed setup array.

Insert the login box plugin on any page. Then, on the same page, after the login box, insert the Agency Registration extension, using the default (DE: ‘normal’) display mode, but setting the Record Storage Page to the folder that will contain the front end user records. Set the TS template constant loginPID to the page id of this page.

Create a second page after the previous one and set the access general options to “ Hide at login ”. Insert the Agency Registration extension, setting the display mode to Create (DE: ‘Anlegen’), and the Record Storage Pageto the folder that will contain the front end user records. Note that the access restriction should be set on the page, not on the content elements.Set the TS template constant registerPID to the page id of this page.

Create a third page limiting access to this page to the second user group you created. Insert the Agency extension, setting the display mode to Edit, and the Record Storage Page to the folderthat will contain the front end user records. Note that the access restriction should be set on the page, not on the content elements.Set the TS template constant editPID to the page id of this page.

Create a fourth page and click the checkbox “ Hide in menu ”. Insert the Agency Registration plugin, using the Default display mode and setting the Record Storage Page to the folder that will contain the front end user records. Note that no access restriction should be set on this page, because otherwise unregistered users cannot see the confirmation page, and they cannot click on the confirmation link. Set the TS template constant confirmPID to the page id of this page.

Decide which fields you want included on the registration form and, among those, which ones you want to be required in order to register. Set TS template constants formFields and requiredFields .

Review the extension constants described below. All these properties may be conveniently edited using the Constant Editor TS template tool. If you do not use the Constant Editor to configure the extension, please note the form of the constants assignments in the constants section of your TS template:

plugin.tx_agency.property = value

or if you assign multiple values:

plugin.tx_agency {
 property = value
...
}

TypoScript Setup:

config.sys_language_uid = 0
config.language = de
config.locale_all = german
config.typolinkLinkAccessRestrictedPages = NONE;

Starting with version 0+¶

When you move from version 2.x.x of sr_feuser_register to agency version 0+:

• Using the TYPO3 Install Tool, frontend (FE) login security level should be configured to ‘normal’, if using an SSL connection, or to ‘rsa’ otherwise. When frontend (FE) login security level is configured to ‘rsa’, the page cannot contain multiple registration/login forms (see: http://forge.typo3.org/issues/34568).
• Use the status report in Admin Tools->Reports to check for possible problems with the installation of the extension (required and conflicting extensions, login security level, salted passwords enablement).
• On accepting an invitation, the user is prompted to choose a password: template subpart ###TEMPLATE_SETFIXED_OK_APPROVE_INVITE### is added to the default template, and may need to be added to custom templates.
• Markers ‘###FIELD_password###’ and ‘###FIELD_password_again###’ are removed from the default HTML template, and should be removed from all custom templates.
• In HTML template subpart, ###TEMPLATE_EDIT###, marker ###LABEL_PASSWORD### is replaced by ###LABEL_NEW_PASSWORD###; the same should be done in custom templates.
• Label variable %5$s is now replaced by an empty string (used to be a clear-text password); the variable should be removed from all custom labels.
• The extension now always uses character set utf-8 by default. If your frontend pages are rendered using a different character set, you may need to set config.renderCharset and/or config.metaCharset in your TS setup.
• The Swift Mailer API provided by TYPO3 is now supported; if using TYPO3 4.5 or TYPO3 4.6, consider setting [‘MAIL’][‘substituteOldMailAPI’] to ‘1’ in the Install tool; with TYPO3 4.7, the old API is not supported anymore.
• Template subpart ###TEMPLATE_CREATE_SAVED_REVIEW### is added; it is displayed when the user has created his account, email confirmation request is disabled, but administrative review is enabled. This subpart may have to be added in custom templetes.
• Template subparts ###SUB_INCLUDED_FIELD_terms_acknowledged### are corrected in the default HTML template and field terms_acknowledged is added to the default form setup.
• Template subparts ###SUB_INCLUDED_FIELD_middle_name### were added to the default HTML template, but field middle_name was not added to the default form setup. You may want to add the field to your setup.
• Subpart ###TEMPLATE_INFOMAIL### of the default HTML template was modified. You should revise your custom template accordingly. Moreover, this subpart now includes subpart ###SUB_INCLUDED_FIELD_captcha_response###.
• Template subparts ###SUB_INCLUDED_FIELD_module_sys_dmail_newsletter### were added to the default HTML template and field module_sys_dmail_newsletter was added to the default form setup. A new TS constant and TS setup property ‘unsubscribeAllowedFields’, allows to specify a list of fields that may be updated, whithout the user having to login, by an UNSUBSCRIBE link from a newsletter mailing application. The following template subparts were added in support of this feature: ###TEMPLATE_SETFIXED_OK_UNSUBSCRIBE###, ###EMAIL_TEMPLATE_SETFIXED_UNSUBSCRIBE_HTML### and ###EMAIL_TEMPLATE_SETFIXED_UNSUBSCRIBE###.
• Static template FE User Registration CSS-styled must be included inyour TS template, otherwise the extension will not work; if you were not already including static template FE User Registration CSS- styled in your TS template, then you need to adapt your HTML template and your CSS styles. You should probably try it first with the default template and the default CSS styles.
• Subparts ###SUB_INCLUDED_FIELD_captcha_response### in the default HTML template were modified in order to use the same definition list structure as the other subparts of the forms. You may want to adjust custom templates accordingly.
• Some new labels are added to the language file. These will need to be translated on the translation server. Until then, they may be translated in TS setup.
• Check your hook functions for new parameters.

If upgrading from a version older than 2.6.0, it is important to update the names of the following subparts in any custom HTML template used with this extension:

EMAIL_TEMPLATE_SETFIXED_REVIEW_HTML becomes EMAIL_TEMPLATE_SETFIXED_REVIEW_ADMIN_HTML

EMAIL_TEMPLATE_SETFIXED_REVIEW becomes EMAIL_TEMPLATE_SETFIXED_REVIEW_ADMIN

Extension configuration variables¶

The Extension Manager installation dialog allows you to set the following extension configuration variables:

• Image upload folder : this is the name of the upload folder for images uploaded by front end users. The default value is uploads/tx_agency. In some configurations, you may prefer to set it to uploads/pics – changes will update the TCA-definition of the image column of the fe_users table;
• Maximum image size: this is the maximum size in kBytes an image may be to be uploaded by front end users. The default value is 250 – changes will update the TCA-definition of the image column of the fe_users table;
• Allowed image types: this is the list of accepted file extensions for uploaded images. The default value is png, jpg, jpeg, gif, tif, tiff – changes will update the TCA-definition of the image column of the fe_users table.

TypoScript Constants¶

Please note that the following properties refer to TS template constants, not to TS template setup.

If you do not use the constant module_sys_dmail_categoryEditor to configure the extension, please note the form of the constants assignments in the constants section of your TS template: plugin. tx_ agency. *property* = *value*

alphaSpecials = äöüß

dateSplit = \.

TypoScript Setup¶

Please note that the following properties refer to TS template setup , not to TS template constants!

When installing this extension, you should NOT use the following setting:

config.disableAllHeaderCode = 1

This setting will prevent the inclusion of Javascript essential to the correct behavior of the profile editing features.

plugin.tx_agency {
 where.static_countries = cn_eu_member = 1
}

plugin.tx_agency {
  where.static_countries = static_countries.cn_iso_3 IN ('AFN','AGO','AIA','ALL','ANT','ARE','ARM','ASM','ATA','ATF','ATG','ASM','AUT','AZE','BDI','BEN','BFA','BGR','BHR','BIH','BLR','BMU','BRB','BRN','BTN','BVT','BWA','CAF','CCK','CIV','CMR','COK','COL','COM','CPV','CRI','CSG','CUB','CXR','CYM','CYP','CZE','DEU','DJI','DNK','DZA','ECU','EGY','ERI','ESH','ESP','EST','ETH','FIN','FJI','FLK','FRO','FSM','GAB','GEO','GHA','GIB','GIN','GLP','GMB','GNB','GNQ','GRD','GRL','GUF','GUY','HMD','HRV','HUN','IRN','IRQ','ISL','ISR','ITA','JAM','JOR','KAZ','KEN','KGZ','KIR','KNA','KWT','LBR','LBN','LBY','LCA','LIE','LSO','LTU','LUX','LVA','MAR','MCO','MDA','MDG','MHL','MKD','MLI','MLT','MNP','MOZ','MRT','MSR','MTQ','MUS','MWI','MYT','NAM','NCL','NER','NFK','NGA','NIC','NLD','NOR','NPL','NRU','OMN','PAK','PCN','PLW','PNG','POL','PYF','QAT','REU','ROU','RUS','RWA','SAU','SDN','SEN','SGS','SHN','SJM','SLE','SLB','SLV','SMR','SOM','SPM','STP','SRB','SUR','SVK','SVN','SWE','SWZ','SYC','SYR','TCA','TCD','TGO','TJS','TKL','TKM','TLS','TON','TTO','TUN','TUR','TZA','UGA','UKR','UMI','URY','UZB','VAT','VCT','VGB','VIR','VNM','VUT','WLF','WSM','XAF','YEM','ZAF','ZAR','ZMB','ZWE')
}

displayRequired = COA
displayRequired {
   10 = TEXT
   10.value = You must fill this in!
   10.wrap = <b>Attention:</b> | *
}

captcha {
        10 {
                extensionKey = sr_freecap
                evalRule = freecap
        }
        20 {
                extensionKey = captcha
                evalRule = captcha
        }
}

Display mode specific¶

Use the display mode (lower case) as the first parameter.

Example:

edit.overrideValues.usergroup = 3

overrideValues {
        username =
        usergroup >
        disable = 0
        by_invitation >
        user_myfield = {TSFE:fe_user|user|user_myfield}
        user_myfield.insertData = 1
}

Registration process¶

Use ‘setfixed’ as the first and the registration process name (upper case) as the second parameter.

Example:

setfixed.ACCEPT {
   _FIELDLIST = uid,pid,usergroup
   usergroup = {$plugin.tx_agency.userGroupAfterAcceptation}
   disable = 0
}

Usergroup generation¶

Use ‘setfixed’ as the first, the registration process name (upper case) as the second parameter and «usergroup» as the third parameter.

Example:

setfixed.ACCEPT.usergroup {
   10.uid = 3
   10.file = fileadmin/Mitglieder.xml

}

Meanings of the array lines:

<?xml version="1.0" ?>
<Members>
<Row>
        <cnum>00001</cnum>
        <last_name>Mustermann</last_name>
        <zip>80100</zip>
        <email>max.mustermann@mail.de</email>
</Row>
<Row>
        <cnum>00002</cnum>
        <last_name>Musterfrau</last_name>
        <zip>80200</zip>
        <email>susi.musterfrau@mail.dk</email>
</Row>
</Members>

Table configuration¶

The last but one/two value will be the name of the view. It can be ‘ALL’, if it is valid for all views..

Views correspond to the display mode in upper case:

EDIT, CREATE

Example:

plugin.tx_agency.conf.sys_dmail_category.ALL.sys_language_uid = 0

Sending invitations¶

Create a page, limiting access to this page to front end user groups who will be authorized to send invitations to register. Insert the Agency Registration plugin, setting the display mode to ‘Invite’ and theStarting Point to the System Folder that will contain the front end user records created.

When an account is created through this page, an invitation message will be sent to the email address specified on the account. The invited person may accept or decline the invitation.

Using frames¶

If the registration confirmation page (confirmPID) is designed to be displayed within frames, then add the following lines to your TS template setup:

[globalVar = TSFE:id = {$plugin.tx_agency.confirmPID}]
config.page.frameReloadIfNotInFrameset = 1
config.linkVars >
config.linkVars =  L,agency,fD,cmd,rU,aC
config.no_cache = 1
[global]

after setting plugin.tx_agency.confirmPID in your TS template constants.

Note that cmd, rU and aC are in the list for compatibility with the Direct mail extension.

Using available hooks¶

Thee sets of hooks may be used by the extension.

The first set of hooks is named confirmRegistrationClass and offers the possibility of the following two hooks:

• confirmRegistrationClass_preProcess : this hook is invoked just BEFORE the registration confirmation (or so-called setfixed) is processed;
• confirmRegistrationClass_postProcess : this hook is invoked just AFTER the registration confirmation (or so-called setfixed) is processed.

The second set of hooks is named registrationProcess and offers the possibility of the following four hooks:

registrationProcess_beforeConfirmCreate : this hook is invoked just BEFORE the user record is filled for preview by the user;

• registrationProcess_afterSaveCreate : this hook is invoked just AFTER the user record has been created and saved;
• registrationProcess_afterSaveEdit : this hook is invoked just AFTER the user record has been edited and saved;

registrationProcess_beforeSaveDelete : this hook is invoked just BEFORE the userrecord is deleted.

The third set of hooks is for global markers and processing.

addGlobalMarkers : This hook is invoked in the fillInMarkerArray function of the marker object. You can add your own global markers here. This is used for the markers from the extensions captcha, sr_freecap, voucher and others.

Each set of hooks must be defined within a class, each hook being a method of this class. However, all seven hooks could be defined as methods of the same class.

Some of the hooks receive two parameters: the current front end user record (or marker array, in the case of addGlobalMarkers) and a reference to the invoking object. In the case of registrationProcess_beforeConfirmCreate, the first parameter is also passed as a reference so that some action may be taken on the content of the record.

The hooks are configured by the following assignments which could be included in the ext_localconf.php file of the extension providing the hooks:

$TYPO3_CONF_VARS['EXTCONF']['agency']['confirmRegistrationClass'][] = classReference;
$TYPO3_CONF_VARS['EXTCONF']['agency']['registrationProcess'][] = classReference;

Note that these are arrays, therefore you could configure multiple hooks of each type for various purposes.

File hooks/class.tx_agency_hooksHandler.php of this extension provides a simple example class containing seven hooks doing nothing but provinding the interface you must use. File ext_localconf.php also contains example statements for configuring these example hooks. They are commented out. If you uncomment them, you should see the hooks being invoked when the extension is used in the front end. You must enter some PHP echo lines into the example hooks.

In the case of the confirmRegistrationClass, if the confirmation page is configured to be redirected to auto-login, you may not notice on the front end that the example hooks are being invoked.

In the case of the registrationProcess_beforeConfirmCreate example hook, if the plugin is configured to generate a username, a username is generated based on the first and last names of the user.

For more information on hooks, see: http://typo3.org/documentation /document-library/core- documentation/doc_core_api/4.2.0/view/3/4/#id4198363 .

Reducing the length of URL’s¶

You may find that the URL’s sent in emails to the front end user are too long and may be broken when using plain text emails.

'postVarSets' => array(
    '_DEFAULT' => array(
        'user' => array(
            array(
                'GETvar' => 'agency[regHash]'
            )
        )
    )
),

Front End Login for Website Users¶

Use the page for login or a top level page, setting the Page “General Storage Storage” to the System Folder that will contain the front end user records created by the extension.

Setting an image upload folder compatible with Frontend Login for Website Users¶

The path of the image upload folder used by the Agency Registration extension may be set in the installation dialog. The default value is uploads/tx_agency . A popular alternative in many configurations is uploads/pics . The Agency Registration extension will update the TCA of the fe_users table. Therefore, the Backend forms will use the specified path.

It is also possible to show the user image in the user listing produced by the Frontend Login for Website Users.

Configure the extension to use the email address as user name¶

Use the Constant editor to set the constant useEmailAsUsername to 1;

You may want to change the relative position of the email field in the following subparts of the HTML template: ###TEMPLATE_CREATE###, ###TEMPLATE_INVITE### and ###TEMPLATE_EDIT###.

Note that if you have set constant enableEmailConfirmation , the email field will not appear on the editing form because no confirmation request is sent when the email address is modified.

Also in tt_products the email addresses are used as user names.

Wrap for Select, Check Boxes and Radio Buttons¶

You can have different select boxes defined in TCA, which can also be shown as checkboxes in FE. You will need this for DirectMail or overwritten topics. The configuration needs the activity (‘create’, ‘edit’, ‘email’ for email, ‘preview’ for preview, ‘input’ for the page with input fields) and the field name of fe_users.

activities: EMAIL

Example Setup :

plugin.tx_agency {
     select {
                email {
                        module_sys_dmail_category.item.wrap = | <br/>
                }
        }
}

Display of Front End User Data¶

If you want to display the FE users data without any edit functionality, you can use TypoScript for setting this up.

by Peter Klein

Example Setup :

lib.userinfo = COA_INT
lib.userinfo {
  10 = TEXT
  10.data = TSFE:fe_user|user|username
  10.wrap = Username:&nbsp;|<br />
  10.required = 1

  # Use "first_name" and "last_name", if present,
  # otherwise use the "name" field
  20 = COA
  20.1 = TEXT
  20.1.data = TSFE:fe_user|user|first_name
  20.1.required = 1
  20.2 = TEXT
  20.2.data = TSFE:fe_user|user|last_name
  20.2.wrap = &nbsp;|
  20.2.required = 1
  20.stdWrap.ifEmpty.data = TSFE:fe_user|user|name
  20.stdWrap.wrap = Name:&nbsp;|<br />
  20.stdWrap.required = 1

  30 <.10
  30.data = TSFE:fe_user|user|address
  30.wrap = Address:&nbsp;|<br />

  40 <.10
  40.data = TSFE:fe_user|user|city
  40.wrap = City:&nbsp;|<br />

  50 <.10
  50.data = TSFE:fe_user|user|zip
  50.wrap = Zip:&nbsp;|<br />

  60 <.10
  60.data = TSFE:fe_user|user|country
  60.wrap = Country:&nbsp;|<br />

  70 <.10
  70.data = TSFE:fe_user|user|company
  70.wrap = Company:&nbsp;|<br />

  80 <.10
  80.data = TSFE:fe_user|user|telephone
  80.wrap = Telephone:&nbsp;|<br />

  90 <.10
  90.data = TSFE:fe_user|user|fax
  90.wrap = Fax:&nbsp;|<br />

  100 <.10
  100.data = TSFE:fe_user|user|email
  100.typolink.parameter.data = TSFE:fe_user|user|email
  100.wrap = Email:&nbsp;|<br />

  110 <.10
  110.data = TSFE:fe_user|user|www
  110.typolink.parameter.data = TSFE:fe_user|user|www
  110.typolink.extTarget = _blank
  110.wrap = WWW:&nbsp;|<br />

  200 < .10
  200.data = TSFE:fe_user|user|usergroup
  200.split {
    token = ,
    cObjNum = 1 || 2
    1 {
     10 = CONTENT
     10.table = fe_groups
      # ID 13 is the folder where I store my FE users and FE groups.
      # Remember to change it to the ID of the folder
      # where YOU store your FE data!!
     10.select.pidInList = 13
     10.select.andWhere.current = 1
     10.select.andWhere.wrap = uid=|
     10.renderObj = TEXT
     10.renderObj.field = title
     10.renderObj.wrap = |,
    }
    2 < .1
    2.10.renderObj.wrap >
  }
  200.wrap = Member of group(s):&nbsp;|<br />

  300 < .10
  300.data = TSFE:fe_user|user|image
  300.split {
    token = ,
    cObjNum = 1
    1 {
     10 = IMAGE
     10.file.import.current = 1
     10.file.import = uploads/tx_agency/
     10.file.width = 100
    }
  }
  300.wrap = Image(s):&nbsp;|<br />

}
page.100 < lib.userinfo

Using Captcha¶

It is possible to activate the display of a captcha image and a text field where the user must enter the text displayed on the image.

Extension sr_freecap or captcha must have been installed. The captcha_response field should not be specified as a required field.

Set in TS Constants:

formFields := addToList(captcha_response)

or, using the TS Constant Editor, add captcha_response to the list of fields

and in TS Setup:

plugin.tx_agency {
  create.evalValues.captcha_response = freecap
}

or in TS Setup:

plugin.tx_agency {
  create.evalValues.captcha_response = captcha
}

The captcha default setup which defines the captcha_response from above is:

plugin.tx_agency {
  captcha {
    10 {
       extensionKey = sr_freecap
       evalRule = freecap
    }
    20 {
       extensionKey = captcha
       evalRule = captcha
    }
  }
}

Notice that the evalRule must be identical to the captcha_response.

Make the user name changeable¶

Use the following setup.

Example:

plugin.tx_agency {
     edit {
              overrideValues {
                    username >
               }
   }
}

Extend the fe_users table¶

The simplest way to extend the fe_users table is to create a small extension that will define the required fields in the database and the TCA. Your small extension will not contain any plugin or other processing.

Extension Kickstarter is a wizard that will help you create this small extension. If not yet installed, install the extension using the Extension Manager. Once installed, you access the Kickstarter Wizard through the Extension Manager back end module. Just remember that you will not need to create any plugin or TypoScript.

Once your extension is created, install it. This will make the fields you have defined available to the TYPO3 backend. In this tutorial the name of the extension is mynewext.

Add the fields in the HTML template¶

You need to update the HTML template in order to include the fields you have defined in the proper subparts. The subparts of interest are:

###TEMPLATE_CREATE###

###TEMPLATE_CREATE_PREVIEW###

###TEMPLATE_INVITE###

###TEMPLATE_INVITE_PREVIEW###

###TEMPLATE_EDIT###

###TEMPLATE_EDIT_PREVIEW###

and perhaps some of the email subparts.

Have a look at how the predefined fields are included in each of the subparts, and do the same for the fields you are adding.

The HTML for a field named myNewFieldNamein the CREATE, INVITE and EDIT subparts would look like:

<!-- ###SUB_INCLUDED_FIELD_myNewFieldName### -->
<dt>
        <label for="agency-myNewFieldName">###LABEL_MYNEWFIELDNAME###</label>
        <span class="agency-required">###REQUIRED_MYNEWFIELDNAME###</span>
</dt>
<dd>
        <!-- ###SUB_ERROR_FIELD_myNewFieldName### -->
        <p class="agency-error">###EVAL_ERROR_FIELD_myNewFieldName###</p>
        <!-- ###SUB_ERROR_FIELD_myNewFieldName### -->
        <!-- ###SUB_REQUIRED_FIELD_myNewFieldName### -->
        <p class="agency-error">###MISSING_MYNEWFIELDNAME###</p>
        <!-- ###SUB_REQUIRED_FIELD_myNewFieldName### -->
        <input id="agency-myNewFieldName" type="text" size="40" maxlength="50" title="###TOOLTIP_MYNEWFIELDNAME###" name="###NAME_MYNEWFIELDNAME###" class="agency-text" />
</dd>
<!-- ###SUB_INCLUDED_FIELD_myNewFieldName### -->

In the case of a field of type textarea, check, radio and select, the HTML for the field should rather look like the following:

<!-- ###SUB_INCLUDED_FIELD_myNewFieldName### -->
<dt>
        <label for="agency-myNewFieldName">###LABEL_MYNEWFIELDNAME###</label>
        <span class="agency-required">###REQUIRED_MYNEWFIELDNAME###</span>
</dt>
<dd>
        <!-- ###SUB_ERROR_FIELD_myNewFieldName### -->
        <p class="agency-error">###EVAL_ERROR_FIELD_myNewFieldName###</p>
        <!-- ###SUB_ERROR_FIELD_myNewFieldName### -->
        <!-- ###SUB_REQUIRED_FIELD_myNewFieldName### -->
        <p class="agency-error">###MISSING_MYNEWFIELDNAME###</p>
        <!-- ###SUB_REQUIRED_FIELD_myNewFieldName### -->
        ###TCA_INPUT_myNewFieldName###
</dd>
<!-- ###SUB_INCLUDED_FIELD_myNewFieldName### →

In each PREVIEW subpart, you need to add lines like:

<!-- ###SUB_INCLUDED_FIELD_myNewFieldName### -->
<dt>###LABEL_MYNEWFIELDNAME###</dt>
<dd>###FIELD_MYNEWFIELDNAME###</dd>
<!-- ###SUB_INCLUDED_FIELD_myNewFieldName### -->

or

<!-- ###SUB_INCLUDED_FIELD_myNewFieldName### -->
<dt>###LABEL_MYNEWFIELDNAME###</dt>
<dd>###TCA_INPUT_myNewFieldName###</dd>
<!-- ###SUB_INCLUDED_FIELD_myNewFieldName### -->

Modify the TS template Constants and Setup¶

Using the Constant Editor, modify the value of the following constants of plugin agency:

formFields : add to the list of fields the names of the fields you have defined and want to be displayed in the front end form. If the field is not in this list, the subpart

<!–###SUB_INCLUDED_FIELD_ myNewFieldName ###–> will be deleted;

requiredFields : add to the list of fields the names of the fields you have defined and want to be treated as required fields. If the field is not in the list OR if the field is in this list and is correctly filled, the subpart

<!–###SUB_REQUIRED_FIELD_ myNewFieldName ###–> will be deleted.

You may also specify in the TS template Setup some default values and validation rules to be applied by the extension to the additional fields.

If there are no validation rules, you should set:

plugin.tx_agency.create.evalValues.myNewFieldName =

If your field is a select field and if you wish to enable multiple selection, you should also set:

plugin.tx_agency.parseValues.myNewFieldName  = multiple

Add the language labels for the new fields¶

The language labels for the additional database fields should be added in Step1 above. These will be used by the Backend forms.

The language labels used by the front end plugin should be added in the TS template setup using the method described in the Localization section of this document. For each language of interest to you with languageCode , which must be replaced by ‘de’, ‘default’ or others. All cursive letters in the following examples must be replaced with your field names and texts.

You may need the following statements for each additional field with myNewFieldName :

The basic field label:

plugin.tx_agency._LOCAL_LANG.languageCode.myNewFieldName = myNewFieldLabel

The message displayed when the field is required but missing:

plugin.tx_agency._LOCAL_LANG.languageCode.missing_myNewFieldName = missingRequiredFieldMessage

Same as previous but for the invitation form:

plugin.tx_agency._LOCAL_LANG.languageCode.missing_invitation_myNewFieldName = missingRequiredFieldMessageOnInvitationForm

The following message displayed when a validation rule evalRuleName applicable to the field is not satisfied:

plugin.tx_agency._LOCAL_LANG.languageCode.evalErrors_evalRuleName_myNewFieldName = errorMessageForEvalRule

Add the hook for $TCA¶

TYPO3 does not read in the $TCA modified in your extension. Therefore agency has a hook which take care that the files ext_tables.php of your extension are read in and its result will be added to the $TCA for the table fe_users also in the front end.

Put this line into the file ext_localconf.php of your extension mynewext (create it, if it does not exist):

if (TYPO3_MODE == 'FE') {
        $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['agency']['extendingTCA'][] = 'mynewext';
}