wiki:Modules/Login
Last modified 6 years ago

Login

  1. Login
    1. Introduction
    2. Package
    3. Parameter prefix
    4. Login.createEntry
      1. Authority
      2. Parameter
        1. Required
        2. Optional
      3. Return tree
    5. Login.deleteEntry
      1. Authority
      2. Parameter
        1. Required
      3. Return tree
    6. Login.createAutoLogin
      1. Authority
      2. Parameter
      3. Return tree

Introduction

The login module handles user login, using username/password, email/password and/or automatic cookie-based authentication.

Package

Core

Parameter prefix

Login

Login.createEntry

Logs a user in.

If you want to allow people to login using either the username OR the email address you have to set /MODULES/LOGIN/ALLOWEMAILLOGIN to true in the corinis.xml

Authority

none

Parameter

Required

loginView.createEntryRequired to perform the function
loginView.usernamethe username (as provided to Modules/UserManager?.createEntry), may also be the email address
loginView.userauththe password assigned to the username

Optional

loginView.rememberSet this to 'true' to enable autologin

Return tree

Standard return tree

Login.deleteEntry

Logs a user out.

This will also delete the remember cookie!

Authority

none

Parameter

Required

loginView.deleteEntryRequired to perform the function

Return tree

Standard return tree

Login.createAutoLogin

This functions looks for the autologin cookie and logs the user in if it is valid and recorded in the database.

The autologin feature remembers the cookie AND the ip address used when the cookie was set. If you have a laptop and have a different IP then when you logged in last, you will be asked for a username/password again.

Authority

none

Parameter

none

Return tree

Standard return tree