Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitCoreModuleUserPasswordAuthentification

Packages:

Interfaces:

Classes:

Core::arbitCoreModuleUserPasswordAuthentification

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

Class arbitCoreModuleUserPasswordAuthentification

Base class for the password user authentication mechanisms.

Base class for the password user authentication mechanisms.

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

Method Summary

public arbitViewModel account( $model , $request )
Controller implementation for password changing Performs the requested actions and changes the password.
protected array checkPassword( $password , $repetition , $data )
Common password checks Performs a list of common checks against the given password, which currently are:
  • Passwords matche sits repetition
  • Minimal password length
  • Password shares not too much text with other provided data
More checks could make sense to implement here or in derivating classes like dictonary checks.
protected array getPasswordHash( $password )
Generate a password hash Generates one or more hashes from a password. function.
public mixed login( $request )
Log in user Tries to log in user with the data provided in the request.
protected string longestCommonSequence( $password , $string )
longest common sequence implementation Returns the longest common sequence of two strings. ensure that the password does not have too much in common with other provided data.
public mixed register( $request )
Register user Tries to register user with the data provided in the request.

Inherited Methods

From arbitCoreModuleUserAuthentification
protected bool arbitCoreModuleUserAuthentification::checkUserExists()
Check if a user with the provided login already exists
public void arbitCoreModuleUserAuthentification::finishRegistration()
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 arbitCoreModuleUserAuthentification::getValidationKey()
Get user validation key The validation key defines the state of the user after registration.
public abstract mixed arbitCoreModuleUserAuthentification::login()
Log in user Tries to log in user with the data provided in the request.
protected void arbitCoreModuleUserAuthentification::loginRedirect()
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 arbitCoreModuleUserAuthentification::register()
Register user Tries to register user with the data provided in the request.
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

account

arbitViewModel account( arbitViewModuleModel $model , arbitHttpRequest $request )

Controller implementation for password changing Performs the requested actions and changes the password.

Controller implementation for password changing Performs the requested actions and changes the password.

Parameters:
Name Type Description
$model arbitViewModuleModel
$request arbitHttpRequest

checkPassword

array checkPassword( string $password , string $repetition , array $data )

Common password checks Performs a list of common checks against the given password, which currently are:

  • Passwords matche sits repetition
  • Minimal password length
  • Password shares not too much text with other provided data
More checks could make sense to implement here or in derivating classes like dictonary checks.

Common password checks Performs a list of common checks against the given password, which currently are:

  • Passwords matche sits repetition
  • Minimal password length
  • Password shares not too much text with other provided data
More checks could make sense to implement here or in derivating classes like dictonary checks. Returns an aray with validation errors.

Parameters:
Name Type Description
$password string
$repetition string
$data array

getPasswordHash

array getPasswordHash( string $password )

Generate a password hash Generates one or more hashes from a password. function.

Generate a password hash Generates one or more hashes from a password. Must be an injective function.

Parameters:
Name Type Description
$password string

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
Redefinition of:
Method Description
arbitCoreModuleUserAuthentification::login() Log in user Tries to log in user with the data provided in the request.

longestCommonSequence

string longestCommonSequence( string $password , string $string )

longest common sequence implementation Returns the longest common sequence of two strings. ensure that the password does not have too much in common with other provided data.

longest common sequence implementation Returns the longest common sequence of two strings. may be used to ensure that the password does not have too much in common with other provided data.

Parameters:
Name Type Description
$password string
$string string

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
Redefinition of:
Method Description
arbitCoreModuleUserAuthentification::register() Register user Tries to register user with the data provided in the request.
Documentation generated on Mon, 05 Apr 2010 14:02:10 +0200 by phpDocumentor 1.4.3

Arbit - project tracking, licensed under GPL 3