EXT: felogin

Extension Key: felogin

Language: en

Keywords: forAdmins, forIntermediates, forAdvanced

Copyright 2007-2010, Steffen Kamper, <info@sk-typo3.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.org

Table of Contents

EXT: felogin	1

Introduction	3

What does it do?	3

Screenshots	3

Users manual	5

Inserting the Plugin on your Page	5

Choosing Storage Folder for Website User	5

Login mechanism	6

What will be displayed?	6

What happens when I log in?	6

Redirect Modes	6

Configuration	8

Known Problems	11

To-Do List	12

Changelog	13

Introduction

What does it do?

The Frontend Login for Website Users (felogin) extension is a general purpose extension for frontend logins. In addition to the actual login box, it includes several methods for redirecting after login/logout and includes forgot password functionality.

It is based on the newloginbox extension and replaces the old TYPO3 Login content element. If you install this extension, it will automatically replace the old form.

Screenshots

General Settings

Redirect Configuration

Messages Tab

Users manual

The felogin extension requires no special configuration. All options are available in the plugin's FlexForm as shown in the screenshots above.

Inserting the Plugin on your Page

Just as with the old login box, the felogin plugin is available through the Content Wizard as “Login Form”:

Choosing Storage Folder for Website User

In order for Website Users to be able to log in, the felogin plugin must know where the records are stored. There are three possibilities for setting this storage folder:

Go to the page where the felogin plugin exists and edit the page properties, setting the field for the “General Record Storage Page” to your storage folder.

Or edit the felogin plugin, setting the field for the “Startingpoint” to your storage folder.

Or set the UID of you storage folder through TypoScript in the setup field of your TypoScript Template:

plugin.tx_felogin_pi1.storagePid = xxx

Login mechanism

In order to properly use the felogin plugin and its advanced capabilities (such as redirect options) it is important to understand the mechanism of frontend user login in TYPO3.

What will be displayed?

If there is no frontend user logged in, the felogin plugin will be shown.

If there is a logged in frontend user, the logout form is shown.

If the forgot password link was used, the form to reset a password based on username or email address will be shown.

If the password reset link was followed from an email, the form to change the password will be shown.

What happens when I log in?

After the form is submitted the TYPO3 authentication services will validate the login credentials. After this process felogin will handle the rest. This means that the felogin plugin must be visible for the user who has logged in.

Felogin will then check any redirect options generate the appropriate content.

Redirect Modes

The following redirect options are supported.

defined by Usergroup Record

Within a Website usergroup record, you can specify a page where usergroup members will be redirected after login.

defined by User Record

This is identical to the redirection option for “defined by Usergroup Record” but applies to a single website user instead of an entire usergroup.

after Login (TS or Flexform)

This redirect page is set either in TypoScript (plugin.tx_felogin_pi1.redirectPageLogin) or in the FlexForm of the felogin plugin.

after Logout (TS or Flexform)

Defines the redirect page after a user has logged out. Again, it can be set in TypoScript or in the felogin plugin's FlexForm.

after Login Error (TS of Flexform)

Defines the redirect page after a login error occurs. Can be set in TypoScript or in the felogin plugin's FlexForm.

defined by GET/POST-Vars

Redirect the visitor based on the GET/POST variable 'redirect_url'. If the TypoScript configuration config.typolinkLinkAccessRestrictedPages is set, the GET/POST parameter 'return_url' is used.

Example url:

http://www.domain.ext/index.php?id=12&redirect_url=http%3A%2F%2Fwww%2Edomain%2Eext%2Fdestiny%2F

defined by Referrer

The referer page is used for the redirect. This basically means that the user is sent back to the page he originally came from.

defined by Domain entries

Same as 'defined by Referrer', except that only the domains listed in plugin.tx_felogin_pi1.domains are allowed. If someone is sent to the login page coming from a domain which is not listed, the redirect will not happen.

By using the option 'Use the first method found' you can define several fallback methods.

Configuration

All configuration options are available in the FlexForm or TypoScript, with the FlexForm settings taking precedence.

plugin.tx_felogin_pi1

Property:	Data type:	Description:	Default:
storagePid	string	Define the Storage Folder with the Website User Records, using a comma seperated list or single value	{$styles.content.loginform.pid}
recursive	bool	If set, also any subfolders of the storagePid will be used	
templateFile.file	string	The Template File	EXT:felogin/template.html
feloginBaseURL	string	Base url if something other than the system base URL is needed	
wrapContentInBaseClass	bool	If set, plugin is wrapped by Standard Base Class-Wrap	true
linkConfig	array	Typolink Configuration for the generated Links	
preserveGETvars	String	When using login plugin on a page with other plugins you might want to have your GET-params preserved. You can define them here. Possible settings: all - takes all GET-vars found comma-separated list - takes defined vars Example: preserveGETvars = tx_ttnews[tt_news],tx_myext[id],...	
showForgotPasswordLink	bool	If set, the section in the template to display the link to the forget password dialogue is visible.	
showPermaLogin	bool	If set, the section in the template to display the option to remember the login (with a cookie) is visible.	
forgetLinkHashValidTime	integer	How many hours the link for forget password is valid	12
newPasswordMinLength	integer	Minimum length of the new password a user sets	6
showLogoutFormAfterLogin	bool	If set, you see direct the logout form after successful login	
welcomeHeader_stdWrap	array	stdWrap for Welcome Header	wrap = <h3>|</h3>
welcomeMessage_stdWrap	array	stdWrap for Welcome Message	wrap = <div>|</div>
successHeader_stdWrap	array	stdWrap for Login SuccessHeader	wrap = <h3>|</h3>
successMessage_stdWrap	array	stdWrap for Login Success Message	wrap = <div>|</div>
logoutHeader_stdWrap	array	stdWrap for Logout Header	wrap = <h3>|</h3>
logoutMessage_stdWrap	array	stdWrap for Logout Message	wrap = <div>|</div>
errorHeader_stdWrap	array	stdWrap for Error Header	wrap = <h3>|</h3>
errorMessage_stdWrap	array	stdWrap for Error Message	wrap = <div>|</div>
forgetHeader_stdWrap	array	stdWrap for Forget Header	wrap = <h3>|</h3>
forgetMessage_stdWrap	array	stdWrap for Forget Message	wrap = <div>|</div>
changePasswordHeader_stdWrap	array	stdWrap for Change Password Header	wrap = <h3>|</h3>
changePasswordMessage_stdWrap	array	stdWrap for Change Password Message	wrap = <div>|</div>
userfields	array	Array of fields from the fe_users table. Each field can have its own stdWrap configuration. These fields can be used as markers in the template (e.g. ###USERNAME###)	username { htmlSpecialChars = 1 wrap = <strong>|</strong> }
redirectMode	string	Comma separated list of redirect modes. Possible values: groupLogin, userLogin, login, getpost, referer, refererDomains, loginError, logout See section on redirect modes for details.	
redirectFirstMethod	bool	If set the first method from redirectMode which is possible will be used	
redirectPageLogin	integer	Page id to redirect to after Login	
redirectPageLoginError	integer	Page id to redirect to after Login Error	
redirectPageLogout	integer	Page id to redirect to after Logout	
redirectDisable	bool	If set redirecting is disabled	
email_from	string	Email address used as sender of the change password emails	
email_fromName	string	Name used as sender of the change password emails	
replyTo	string	Reply-to address used in the change password emails	
domains	string	Comma separated list of domains which are allowed for the referrer redirect mode	
dateFormat	date-conf	Format for the link is valid until message (forget password email)	Y-m-d H:i
linkPrefix	string	Prefix for the link sent in the forgot password email	
_CSS_DEFAULT_STYLE	string	CSS included in the page containing the login form	.tx-felogin-pi1 label { display: block; }
_LOCAL_LANG	array	Overrides the language strings in the extension	
_DEFAULT_PI_VARS	array	Default values for variables sent from the forms.	

[tsref:plugin.tx_felogin_pi1]

Language labels

Label:	Usage:
ll_welcome_header	status header
ll_welcome_message	status message
ll_logout_header	status header
ll_logout_message	status message
ll_error_header	status header
ll_error_message	status message
ll_success_header	status header
ll_success_message	status message
ll_status_header	status header
ll_status_message	status message
cookie_warning	Warning when no cookie can be set
username	form field label
password	form field label
login	legend, form field label
permalogin	form field label
logout	legend, submit button
send_password	submit button
reset_password	legend, submit button
ll_change_password_header	status header
ll_change_password_message	status message
ll_change_password_nolinkprefix_message	error message
ll_change_password_notvalid_message	status message
ll_change_password_notequal_message	status message
ll_change_password_tooshort_message	status message
ll_change_password_done_message	status message
change_password	legend
newpassword_label1	form field label
newpassword_label2	form field label
your_email	form field label
ll_forgot_header	status header, link text
ll_forgot_validate_reset_password	email body
ll_forgot_message_emailSent	status message
ll_forgot_reset_message	status message
ll_forgot_reset_message_emailSent	status message
ll_forgot_header_backToLogin	backlink to loginform
ll_enter_your_data	label form field
oLabel_header_welcome	legend

[tsref:plugin.tx_felogin_pi1._LOCAL_LANG.<language|default>]

Known Problems

none at the moment

To-Do List

Handling of user-protected pages

Changelog

1.0.0 Initial Release

EXT: felogin - felogin	Known Problems

3

EXT: felogin

felogin

forAdmins forIntermediates forAdvanced

The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists.
If your manual is NOT in english, see next tab "language"
----
forEditors (use this for editors / german "Redakteure")
forAdmins (use this for Administrators)
forDevelopers (use this for Developers)
forBeginners (manuals covering TYPO3 basics)
forIntermediates (manuals going into more depth)
forAdvanced (covering the most advanced TYPO3 topics)
see more: http://wiki.typo3.org/doc_template#tags
----

2010-04-12T16:08:20