Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitCoreModuleUserOpenIDAuthentification

Packages:

Interfaces:

Classes:

Core::arbitCoreModuleUserOpenIDAuthentification

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

Class arbitCoreModuleUserOpenIDAuthentification

Base class for the OpenID user authentication mechanisms.

Base class for the OpenID user authentication mechanisms.

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

Method Summary

public arbitViewModuleModel handleCustom( $request , $model )
Handle custom dispatched request Handle a custom request to the specific auth controller, which is completely interpreted by this implementation.
public mixed login( $request )
Log in user Tries to log in user with the data provided in the request.
protected arbitViewModuleModel loginUser( $request , $model )
Perform user login
public mixed register( $request )
Register user Tries to register user with the data provided in the request.
protected arbitViewModuleModel registerUser( $request , $model , $data )
Perform user registration
protected mixed startOpenIdAuthentification( )
Start OpenID authentication process Initializes the OpenID authentication process wither with an error, or by forwarding to the OpenID provider. handleCustom() method.

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

handleCustom

arbitViewModuleModel handleCustom( arbitHttpRequest $request , arbitViewModuleModel $model )

Handle custom dispatched request Handle a custom request to the specific auth controller, which is completely interpreted by this implementation.

Handle custom dispatched request Handle a custom request to the specific auth controller, which is completely interpreted by this implementation. In case of OpenID this means that we can evaluate the challenge response here.

Parameters:
Name Type Description
$request arbitHttpRequest
$model arbitViewModuleModel

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.

loginUser

arbitViewModuleModel loginUser( arbitHttpRequest $request , arbitViewModuleModel $model )

Perform user login

Perform user login

Parameters:
Name Type Description
$request arbitHttpRequest
$model arbitViewModuleModel

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.

registerUser

arbitViewModuleModel registerUser( arbitHttpRequest $request , arbitViewModuleModel $model , $data )

Perform user registration

Perform user registration

Parameters:
Name Type Description
$request arbitHttpRequest
$model arbitViewModuleModel
$data array

startOpenIdAuthentification

mixed startOpenIdAuthentification( )

Start OpenID authentication process Initializes the OpenID authentication process wither with an error, or by forwarding to the OpenID provider. handleCustom() method.

Start OpenID authentication process Initializes the OpenID authentication process wither with an error, or by forwarding to the OpenID provider. The response is handled inside the handleCustom() method.

Documentation generated on Mon, 05 Apr 2010 14:02:07 +0200 by phpDocumentor 1.4.3

Arbit - project tracking, licensed under GPL 3