Translations
Info
All page names need to be in English.
en da  de  fr  it  ja  km  nl  ru  zh

Felogin

From TYPO3Wiki
Jump to: navigation, search
Extension detail information
felogin
This extension let you add a login box to Typo3 web sites
documentation state needs a review document state list
licence OCL
forgeproject
mailinglist
usergroups list of usergroups forAdmins, forIntermediates
author(s) Steffen Kamper
TER category fe
dependency 4.0?, cms, css_styled_content

<< Back to Extension manuals page

[edit]


Introduction

What does it do?

The felogin extension is an improved version of the newloginbox extension for use as a general Website User Login. Included are several redirect methods with a varity of usage. The felogin is thought as a replacement for the “old” TYPO3 Login content element. If you install this extension, it will automatically replace the old form.

Screenshots

How to add the plugin

The general options

The redirect options
All the messages can be easily altered

More uploads via Special:Upload

Users manual

You can use the felogin extension “out-of-the-box”. You can set all options in the Flexform.

Inserting the plugin

Just as the plain old login box, insert the felogin plugin through the Content Wizard (Login Form): Insert the plugin the usual way

Locate user information

You have to specify a place (Storage Folder) where to store the information about all the users that are allowed to log. There are three possibilities to choose the Storage Folder:

  1. Either edit the page properties of the page where the FE Login plugin was added before. Select the storage folder in the option “General Record Storage Page”
  2. or edit the plugin (the content element) and choose a folder at the “Startingpoint” option
  3. or define the folder through TypoScript in the setup field of your TS Template like this:
    plugin.tx_felogin_pi1.storagePid = xxx

Note: FE Users need to be in a FE User group in order to be able to log in!

Redirect options

Redirect Mode Description
defined by Usergroup Record Redirect to the page which was choosen in the property "Redirect at Login to Page" of the website usergroup (fe_group) record. If the user is member of more than one group, the first group with a redirect is used.
defined by User Record Redirect to the page which was choosen in the property "Redirect at Login to Page" of the website user (fe_user) record.
after Login (TS or Flexform) Redirect to the page which was selected below in the FlexForm field "After successful login redirect to page".
after Logout (TS or Flexform) Redirect to the page which was selected below in the FlexForm field "After logout redirect to page".
after Login Error (TS or Flexform) Redirect to the page which was selected below in the FlexForm field "After login with error redirect to page".
defined by GET/POST-Vars Redirects to the URL passed in parameter. Example: http://www.domain.tld/index.php?id=12&return_url=index.php?id=398
defined by Referrer Redirects to the referrer page from where the user was refered to the login page. For example, a page (id=123) links to the login page (id=456). If a user visits the page 123 and follows the link to the login, he gets redirected back to page 123 after successful login. This features uses the HTTP_REFERER server environment variable. It requires that the browser transmits this variable. This feature requires the GETvar "referer" to be set to the page you want the user to return to after login.

This can be done by setting this in your TS setup:

config.typolinkLinkAccessRestrictedPages = 1
config.typolinkLinkAccessRestrictedPages_addParams = &referer=###RETURN_URL###

Note: You have to disable "Show login form after login" ("Abmeldeformular nach erfolgreicher Anmeldung zeigen") in order to get this option to work.

defined by Domain entries Redirects to the referrer page like above in "defined by Referrer", but for external websites. The redirect is only processed if the domain is configured in TypoScript plugin.tx_felogin_pi1.domains
Option Description


Use the first Mode found: If set and more than one redirect mode is selected above, the first mode determines the redirection. Otherwise the last one is used for redirection. Please note that only those modes are taken into account which have a valid redirect page configured.
After successful login
redirect to page:
Select the page to be redirected to. This works only when "after Login (TS or Flexform)" was selected in the "Redirect Mode" (see above).
After login with error
redirect to page:
Select the page to be redirected to. This works only when "after Login Error (TS or Flexform)" was selected in the "Redirect Mode" (see above).
After logout
redirect to page:
Select the page to be redirected to. This works only when "after Logout (TS or Flexform)" was selected in the "Redirect Mode" (see above).
Disable redirect Ignores all above selection and disables redirects after any action. This is a convenient way to disable redirect settings without loosing the configuration itself.

Configuration

You can either configure all options through the Flexform or through TypoScript. The Flexform configuration always takes precedence before the TypoScript settings.

plugin.tx_felogin_pi1

Property: Data type: Description: Default:
storagePid string Define the Storage Folder with the Website User Records, use commaseperated list or single value {$styles.content.loginform.pid}
templateFile string The Template File. Example:
plugin.tx_felogin_pi1.templateFile = fileadmin/templates/login.html
EXT:felogin/template.html
wrapContentInBaseClass boolean If set, plugin is wrapped by Standard BaseClass-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-variables that are found
* comma-seperated list - takes only the defined variables. Example:
preserveGETvars = tx_ttnews[tt_news],tx_myext[id],...
showForgotPasswordLink boolean If the "Forgot password?" link should be visible. Is easier to set in the flexform.
showPermaLogin boolean If the "Permanent login?" link should be visible. Is easier to set in the flexform.
welcomeHeader_stdWrap array stdWrap for the Welcome header wrap = <h3>|</h3>
welcomeMessage_stdWrap array stdWrap for the Welcome message wrap = <div>|</div>
successHeader_stdWrap array stdWrap for the Login success header wrap = <h3>|</h3>
successMessage_stdWrap array stdWrap for the Login success message wrap = <div>|</div>
logoutHeader_stdWrap array stdWrap for the Logout header wrap = <h3>|</h3>
logoutMessage_stdWrap array stdWrap for the Logout message wrap = <div>|</div>
errorHeader_stdWrap array stdWrap for the Error header. Example:
plugin.tx_felogin_pi1.errorHeader_stdWrap.wrap = <h2>|</h2>
wrap = <h3>|</h3>
errorMessage_stdWrap array stdWrap for the Error message. Example:
plugin.tx_felogin_pi1.errorMessage_stdWrap.wrap = <p>|</p>
wrap = <div>|</div>
forgotHeader_stdWrap array stdWrap for the Forgot password header wrap = <h3>|</h3>
forgotMessage_stdWrap array stdWrap for the Forgot password message wrap = <div>|</div>
forgotResetMessageEmailSentMessage_stdWrap array stdWrap for the Reset Message Email Sent message wrap = <div>|</div>
changePasswordHeader_stdWrap array stdWrap for the Change password header wrap = <h3>|</h3>
changePasswordMessage_stdWrap array stdWrap for the Change password message wrap = <div>|</div>
redirectMode string See user manual section of redirect mode. Possible values: groupLogin, userLogin, login, logout, loginError, getpost, referer, refererDomains
redirectFirstMethod boolean If set and more than one redirect mode is selected above, the first mode determines the redirection. Otherwise the last one is used for redirection. Please note that only those modes are taken into account which have a valid redirect page configured.
redirectPageLogin PID The page to be redirected to if redirect mode is: plugin.tx_felogin_pi1.redirectMode = login
redirectPageLoginError PID The page to be redirected to if redirect mode is: plugin.tx_felogin_pi1.redirectMode = loginError
redirectPageLogout PID The page to be redirected to if redirect mode is: plugin.tx_felogin_pi1.redirectMode = logout
redirectDisable boolean If set, redirection is disabled
domains list List of allowed domains for redirect mode "defined by Domain entries". Example:
plugin.tx_felogin_pi1.domains = www.example.com, http://www.example.net
forgotLinkHashValidTime int Time in hours how long the link for forget password is valid

Known problems

  • Redirects don't work correctly. => Fixed in 1.3.0 (= TYPO3 4.3.1 and 4.2.11)

To-Do list

Handling of user-protected pages

Changelog

  • 1.3.0 Changes with redirects
  • 1.2.0 Created this wiki page and ???
  • 1.0.0 Initial Release

Wishlist

Any Template Demonstration was nice

Any documentation on available language markers should be in here, too