Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitCoreModuleUserAuthentification

Packages:

Interfaces:

Classes:

Core::arbitCoreModuleUserAuthentification

[ Index ] [ Core classes ] [ Core elements ] [ All elements ] [ Errors ]

Class arbitCoreModuleUserAuthentification

Base interface for user authentication mechanisms.

Base interface for user authentication mechanisms.

ezcMvcController
   |
   --arbitController
      |
      --arbitCoreModuleUserAuthentification
Author(s):
Version:   $Revision: 1692 $
License:   GPL

Descendants

Child Class Description
arbitCoreModuleUserPasswordAuthentification Base class for the password user authentication mechanisms.
arbitCoreModuleUserOpenIDAuthentification Base class for the OpenID user authentication mechanisms.

Method Summary

protected bool checkUserExists( $login )
Check if a user with the provided login already exists
public void finishRegistration( $request , $user )
Finish registration process for user Finish the registration process for the given user, by assigning the validation key and perform other necssary actions.
protected string getValidationKey( )
Get user validation key The validation key defines the state of the user after registration.
public abstract mixed login( $request )
Log in user Tries to log in user with the data provided in the request.
protected void loginRedirect( $request )
Redirect lgged in user Perform a redirect for user which just logged in. site where the log in has been requested or to the project overview page.
public abstract mixed register( $request )
Register user Tries to register user with the data provided in the request.

Inherited Methods

From arbitController
public static string arbitController::createActionMethodName()
Creates a method name to call from an action name.
public ezcMvcResult|ezcMvcInternalRedirect arbitController::createResult()
Runs the controller to process the query and return variables usable to render the view.
protected void arbitController::setRequestVariables()
Don't copy shit here.
public void arbitController::__call()
Wrapper for unknown actions Wrapper for unknown actions, which throws an exception instead of causing PHP to report a fatal error.

Methods

checkUserExists

bool checkUserExists( string $login )

Check if a user with the provided login already exists

Check if a user with the provided login already exists

Parameters:
Name Type Description
$login string

finishRegistration

void finishRegistration( arbitRequest $request , arbitModelUser $user )

Finish registration process for user Finish the registration process for the given user, by assigning the validation key and perform other necssary actions.

Finish registration process for user Finish the registration process for the given user, by assigning the validation key and perform other necssary actions.

Parameters:
Name Type Description
$request arbitRequest
$user arbitModelUser

getValidationKey

string getValidationKey( )

Get user validation key The validation key defines the state of the user after registration.

Get user validation key The validation key defines the state of the user after registration. Depending on the configuration this should return one of the following values.

  • '0': User account disabled
  • '1': User account enabled
  • 'random string': User validation key
If set to a random string the user will receive a mail with the key and can enable the account himself.

login

mixed login( arbitRequest $request )

Log in user Tries to log in user with the data provided in the request.

Log in user Tries to log in user with the data provided in the request. If the log in request is valid the user status in the session is changed and the method will return true. If the registration process fails, an array with errors is returned associated with the respective input field.

Parameters:
Name Type Description
$request arbitRequest
Redefined in descendants as:
Method Description
arbitCoreModuleUserPasswordAuthentification::login() Log in user Tries to log in user with the data provided in the request. 
arbitCoreModuleUserOpenIDAuthentification::login() Log in user Tries to log in user with the data provided in the request. 

loginRedirect

void loginRedirect( arbitRequest $request )

Redirect lgged in user Perform a redirect for user which just logged in. site where the log in has been requested or to the project overview page.

Redirect lgged in user Perform a redirect for user which just logged in. Either back to the site where the log in has been requested or to the project overview page.

Parameters:
Name Type Description
$request arbitRequest

register

mixed register( arbitRequest $request )

Register user Tries to register user with the data provided in the request.

Register user Tries to register user with the data provided in the request. If the registration request is valid the user status in the session is chenged and the method will return true. If the registration process fails, an array with errors is returned associated with the respective input field.

Parameters:
Name Type Description
$request arbitRequest
Redefined in descendants as:
Method Description
arbitCoreModuleUserPasswordAuthentification::register() Register user Tries to register user with the data provided in the request. 
arbitCoreModuleUserOpenIDAuthentification::register() Register user Tries to register user with the data provided in the request. 
Documentation generated on Mon, 05 Apr 2010 14:01:35 +0200 by phpDocumentor 1.4.3

Arbit - project tracking, licensed under GPL 3