GemsTracker library API
Back to top  

Index controller, this one handles the default login / logout actions

package Gems
subpackage Default
copyright Copyright (c) 2011 Erasmus MC
license New BSD License
since Class available since version 1.0
inherited_from \Gems_Controller_Action

 Methods

Adds one or more messages to the session based message store.

addMessage($message, $status = null) : \MUtil_Controller_Action
Inherited

Parameters

$message

$status

Returns

\MUtil_Controller_Action

Modify this to set a new title for the child organization element if you use layered login

getChildOrganizationDescription() : string

Returns

string

Returns a session based message store for adding messages to.

getMessenger() : \Zend_Controller_Action_Helper_FlashMessenger
Inherited

Returns

\Zend_Controller_Action_Helper_FlashMessenger

Modify this to set a new title for the top organization element if you use layered login

getTopOrganizationDescription() : string

Returns

string

Dummy: always rerouted by GemsEscort

indexAction() 

Intializes the html component.

initHtml(boolean $reset = false) : void
Inherited

Parameters

$reset

boolean

Throws away any existing html output when true

Default login page

loginAction() 

Default logoff action

logoffAction() 

Reset password page.

resetpasswordAction() 

Send the user an e-mail with a link for password reset

sendUserResetEMail(\Gems_User_User $user) : mixed

Parameters

$user

\Gems_User_User

Returns

mixedstring or array of Errors or null when successful.

Set the session based message store.

setMessenger(\Zend_Controller_Action_Helper_FlashMessenger $messenger) : \MUtil_Controller_Action
Inherited

Parameters

$messenger

\Zend_Controller_Action_Helper_FlashMessenger

Returns

\MUtil_Controller_Action

Returns a login form

createLoginForm(boolean $showToken = null, boolean $showPasswordLost = null) : \Gems_User_Form_LoginForm

Parameters

$showToken

boolean

Optional, show 'Ask token' button, $this->showTokenButton is used when not specified

$showPasswordLost

boolean

Optional, show 'Lost password' button, $this->showPasswordLostButton is used when not specified

Returns

\Gems_User_Form_LoginForm

Gets a reset password form.

createResetRequestForm() : \Gems_User_Form_ResetForm

Returns

\Gems_User_Form_ResetForm

Function for overruling the display of the login form.

displayLoginForm(\Gems_User_Form_LoginForm $form) 

Parameters

$form

\Gems_User_Form_LoginForm

Function for overruling the display of the reset form.

displayResetForm(\Gems_Form_AutoLoadFormAbstract $form, mixed $errors) 

Parameters

$form

\Gems_Form_AutoLoadFormAbstract

Rset password or reset request form

$errors

mixed

Stub for overruling default snippet loader initiation.

loadSnippetLoader() 
Inherited

Helper function to safely switch org during login

setCurrentOrganizationTo(\Gems_User_User $user) 

Parameters

$user

\Gems_User_User

 Properties

 

$accesslog

$accesslog : \Gems_AccessLog

Default

 

$currentUser

$currentUser : \Gems_User_User

Default

 

$db

$db : \Zend_Db_Adapter_Abstract

Default

 

$loader

$loader : \Gems_Loader

Default

 

$messenger

$messenger : \Zend_Controller_Action_Helper_FlashMessenger

Default

 

$util

$util : \Gems_Util

Default

 

The width factor for the label elements.

$labelWidthFactor : float

Default

null

Width = (max(characters in labels) * labelWidthFactor) . 'em'

 

Use a flat login (false = default) or a layered login where you first select a parent organization and then see a list of child organizations.

$layeredLogin : boolean

Default

false
 

For small numbers of organizations a multiline selectbox will be nice. This setting handles how many lines will display at once. Use 1 for the normal dropdown selectbox

$organizationMaxLines : integer

Default

6
 

When true, the rese4t form returns to the login page after sending a change request

$returnToLoginAfterReset : boolean

Default

true
 

The default behaviour for showing a lost password button

$showPasswordLostButton : boolean

Default

true
 

The default behaviour for showing an 'ask token' button

$showTokenButton : boolean

Default

true