Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitCoreModuleController

Packages:

Interfaces:

Classes:

Core::arbitCoreModuleController

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

Class arbitCoreModuleController

Main controller for the arbit project tracker, implementing all user and group related functionality.

Main controller for the arbit project tracker, implementing all user and group related functionality.

ezcMvcController
   |
   --arbitController
      |
      --arbitCoreModuleController
Author(s):
Version:   $Revision: 1683 $
License:   GPL

Member Variables

protected array $authIds = array(
'arbitCoreModuleUserPasswordAuthentification' => 'password',
'arbitCoreModuleUserOpenIDAuthentification' => 'openid',
)
Array with authentification class short identifiers for nicer URLs and identification.

Array with authentification class short identifiers for nicer URLs and identification.
protected arbitBackendIniProjectConfiguration $conf
The currents project configuration

The currents project configuration
protected string $project
Currently selected project, the controller is called for.

Currently selected project, the controller is called for.

Method Summary

public static void checkPersitentLogin( $request )
Check for persistent login Check if the user provides a persistent login token. the user in directly and update the used token.
public void __construct( $project )
Create controlelr from project name
public arbitViewModuleModel about( $request )
About view
public arbitViewModuleModel accept( $request )
Manage users Manage user validation states and user group associations.
public arbitViewModuleModel account( $request )
Personal user account management Manage user account details, change account data and authentification data, if modifyable.
public arbitViewModuleModel confirm( $request )
Confirm user registration During the registration process may receive a link with a confirmation request.
protected array findAndAdd( $array , $key , $add )
Find key in array and add new child Find the specified key in the given array and add a new child array with the specified key in $add.
protected array findAndRemove( $array , $key )
Find key in array and remove subtree Find the specified key in the given array and remove the complete associated subtree.
protected array getAuthMechanisms( )
Get list of auth mechanisms Return the list of authentification mechanisms to use, with a shorter indetifier for the internal authentification handlers, so we get easier URLs.
protected array getMenu( )
Return the menu for the core controller
protected arbitViewCoreUserModel getProjectAdministrators( $administrators )
Creates a view model with all administrator users for the current project.
public arbitViewModuleModel index( $request )
Dummy action
public arbitViewModuleModel login( $request )
Log in user Action to perform user login. user authenfication mechanism, which need to check if the provided login data is valid.
public arbitViewModuleModel logout( $request )
Log out user
protected array moveDownInArray( $array , $moveKey )
Move element down in array MMove the elment specified by its key one step down in the given array and return the resulting array.
public arbitViewModuleModel permissions( $request )
Manage group permissions
public arbitViewModuleModel project( $request )
Manage and configure current project Management of the current project, which means, that the configuration options are displayed and the list of available versions may be modified.
public arbitViewCoreUserRegistrationModel register( $request )
User registration Display a registration form with the available registration mechanisms and dispatch to the authentification mechanisms implementation on data retrieval for the actual user registration.
public arbitViewModuleModel registered( $request )
Successfully registered user.
public arbitViewModuleModel user( $request )
Manage users Manage user group associations.
public arbitViewModuleModel __call( $call , $parameters )
Dispatch calls to authentification mechanisms Dispatches all calls where the name of the action equals one of the authentification mechanisms to the respective implementation to make specific implementation possible, like a "Forgot Password" feature which is not required for OpenId.

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

checkPersitentLogin

static void checkPersitentLogin( arbitRequest $request )

Check for persistent login Check if the user provides a persistent login token. the user in directly and update the used token.

Check for persistent login Check if the user provides a persistent login token. In this case log the user in directly and update the used token. Meant to be run as a request filter.

Parameters:
Name Type Description
$request arbitRequest

__construct

void __construct( string $project )

Create controlelr from project name

Create controlelr from project name

Parameters:
Name Type Description
$project string

about

arbitViewModuleModel about( arbitRequest $request )

About view

About view

Parameters:
Name Type Description
$request arbitRequest

accept

arbitViewModuleModel accept( arbitRequest $request )

Manage users Manage user validation states and user group associations.

Manage users Manage user validation states and user group associations.

Parameters:
Name Type Description
$request arbitRequest

account

arbitViewModuleModel account( arbitRequest $request )

Personal user account management Manage user account details, change account data and authentification data, if modifyable.

Personal user account management Manage user account details, change account data and authentification data, if modifyable.

Parameters:
Name Type Description
$request arbitRequest

confirm

arbitViewModuleModel confirm( arbitRequest $request )

Confirm user registration During the registration process may receive a link with a confirmation request.

Confirm user registration During the registration process may receive a link with a confirmation request. This action processes this confirmation requests.

Parameters:
Name Type Description
$request arbitRequest

findAndAdd

array findAndAdd( $array , string $key , string $add )

Find key in array and add new child Find the specified key in the given array and add a new child array with the specified key in $add.

Find key in array and add new child Find the specified key in the given array and add a new child array with the specified key in $add.

Parameters:
Name Type Description
$array array
$key string
$add string

findAndRemove

array findAndRemove( $array , string $key )

Find key in array and remove subtree Find the specified key in the given array and remove the complete associated subtree.

Find key in array and remove subtree Find the specified key in the given array and remove the complete associated subtree.

Parameters:
Name Type Description
$array array
$key string

getAuthMechanisms

array getAuthMechanisms( )

Get list of auth mechanisms Return the list of authentification mechanisms to use, with a shorter indetifier for the internal authentification handlers, so we get easier URLs.

Get list of auth mechanisms Return the list of authentification mechanisms to use, with a shorter indetifier for the internal authentification handlers, so we get easier URLs.

getMenu

array getMenu( )

Return the menu for the core controller

Return the menu for the core controller

getProjectAdministrators

arbitViewCoreUserModel getProjectAdministrators( $administrators )

Creates a view model with all administrator users for the current project.

Creates a view model with all administrator users for the current project.

Parameters:
Name Type Description
$administrators array

index

arbitViewModuleModel index( arbitRequest $request )

Dummy action

Dummy action

Parameters:
Name Type Description
$request arbitRequest

login

arbitViewModuleModel login( arbitRequest $request )

Log in user Action to perform user login. user authenfication mechanism, which need to check if the provided login data is valid.

Log in user Action to perform user login. This is done on the base of the stored user authenfication mechanism, which need to check if the provided login data is valid.

Parameters:
Name Type Description
$request arbitRequest

logout

arbitViewModuleModel logout( arbitRequest $request )

Log out user

Log out user

Parameters:
Name Type Description
$request arbitRequest

moveDownInArray

array moveDownInArray( array $array , mixed $moveKey )

Move element down in array MMove the elment specified by its key one step down in the given array and return the resulting array.

Move element down in array MMove the elment specified by its key one step down in the given array and return the resulting array.

Parameters:
Name Type Description
$array array
$moveKey mixed

permissions

arbitViewModuleModel permissions( arbitRequest $request )

Manage group permissions

Manage group permissions Interface for managing group permissions

Parameters:
Name Type Description
$request arbitRequest

project

arbitViewModuleModel project( arbitRequest $request )

Manage and configure current project Management of the current project, which means, that the configuration options are displayed and the list of available versions may be modified.

Manage and configure current project Management of the current project, which means, that the configuration options are displayed and the list of available versions may be modified. This action methods is quite lon because it handles lots of different request types, which are operations on the project configuration data. This could be split up in several views.

Parameters:
Name Type Description
$request arbitRequest

register

arbitViewCoreUserRegistrationModel register( arbitRequest $request )

User registration Display a registration form with the available registration mechanisms and dispatch to the authentification mechanisms implementation on data retrieval for the actual user registration.

User registration Display a registration form with the available registration mechanisms and dispatch to the authentification mechanisms implementation on data retrieval for the actual user registration.

Parameters:
Name Type Description
$request arbitRequest

registered

arbitViewModuleModel registered( arbitRequest $request )

Successfully registered user.

Successfully registered user. If a user sucessfully registerd in the system this page tells him about his current state and sends an email with its validation code, if necessary.

Parameters:
Name Type Description
$request arbitRequest

user

arbitViewModuleModel user( arbitRequest $request )

Manage users Manage user group associations.

Manage users Manage user group associations.

Parameters:
Name Type Description
$request arbitRequest

__call

arbitViewModuleModel __call( string $call , $parameters )

Dispatch calls to authentification mechanisms Dispatches all calls where the name of the action equals one of the authentification mechanisms to the respective implementation to make specific implementation possible, like a "Forgot Password" feature which is not required for OpenId.

Dispatch calls to authentification mechanisms Dispatches all calls where the name of the action equals one of the authentification mechanisms to the respective implementation to make specific implementation possible, like a "Forgot Password" feature which is not required for OpenId.

Parameters:
Name Type Description
$call string
$parameters array
Redefinition of:
Method Description
arbitController::__call() Wrapper for unknown actions Wrapper for unknown actions, which throws an exception instead of causing PHP to report a fatal error.
Documentation generated on Mon, 05 Apr 2010 14:01:45 +0200 by phpDocumentor 1.4.3

Arbit - project tracking, licensed under GPL 3