Delegates authentication to the Radius server

Configuration should be done at organization level, and users should still be added and created as usual. There is now way of changing the remote password. It might be possible to show a custom message maybe with a link to the place where people can change their password in the near future but that is not planned for now.

package Gems
subpackage User
copyright Copyright (c) 2011 Erasmus MC
license New BSD License
since Class available since version 1.5
inherited_from \Gems_User_StaffUserDefinition

 Methods

Appends the needed fields for this config to the $bridge

addConfigFields(\MUtil_Model_ModelAbstract $orgModel) 
inherited_from \Gems_User_UserDefinitionConfigurableInterface::addConfigFields()

Parameters

$orgModel

\MUtil_Model_ModelAbstract

Return true if a password reset key can be created.

canResetPassword(\Gems_User_User $user = null) : boolean

Returns the setting for the definition whan no user is passed, otherwise returns the answer for this specific user.

Parameters

$user

\Gems_User_User

Optional, the user whose password might change

Returns

boolean

Return true if a password reset key can be created.

canResetPassword(\Gems_User_User $user = null) : boolean
Inherited

Returns the setting for the definition whan no user is passed, otherwise returns the answer for this specific user.

inherited_from \Gems_User_UserDefinitionInterface::canResetPassword()

Parameters

$user

\Gems_User_User

Optional, the user whose password might change

Returns

boolean

Return true if the password can be set.

canSetPassword(\Gems_User_User $user = null) : boolean

Returns the setting for the definition whan no user is passed, otherwise returns the answer for this specific user.

Parameters

$user

\Gems_User_User

Optional, the user whose password might change

Returns

boolean

Return true if the password can be set.

canSetPassword(\Gems_User_User $user = null) : boolean
Inherited

Returns the setting for the definition whan no user is passed, otherwise returns the answer for this specific user.

inherited_from \Gems_User_UserDefinitionInterface::canSetPassword()

Parameters

$user

\Gems_User_User

Optional, the user whose password might change

Returns

boolean

Returns an initialized \Zend_Auth_Adapter_Interface

getAuthAdapter(\Gems_User_User $user, string $password) : \Zend_Auth_Adapter_Interface

Parameters

$user

\Gems_User_User

$password

string

Returns

\Zend_Auth_Adapter_Interface

Returns an initialized \Zend_Auth_Adapter_Interface

getAuthAdapter(\Gems_User_User $user, string $password) : \Zend_Auth_Adapter_Interface
Inherited

Parameters

$user

\Gems_User_User

$password

string

Returns

\Zend_Auth_Adapter_Interface

Return the number of changed records for the save performed

getConfigChanged() 
inherited_from \Gems_User_UserDefinitionConfigurableInterface::getConfigChanged()

Return a password reset key, never reached as we can not reset the password

getPasswordResetKey(\Gems_User_User $user) : string

Parameters

$user

\Gems_User_User

The user to create a key for.

Returns

string

Return a password reset key

getPasswordResetKey(\Gems_User_User $user) : string
Inherited
inherited_from \Gems_User_UserDefinitionInterface::getPasswordResetKey()

Parameters

$user

\Gems_User_User

The user to create a key for.

Returns

string

Returns the number of hours a reset key remains valud

getResetKeyDurationInHours() : integer
Inherited
inherited_from \Gems_User_UserDefinitionInterface::getResetKeyDurationInHours()

Returns

integer

Returns a user object, that may be empty if the user is unknown.

getUserData(string $login_name, integer $organization) : array
Inherited

Parameters

$login_name

string

$organization

integer

Returns

arrayOf data to fill the user with.

Do we need to add custom config parameters to use this definition?

hasConfig() : boolean

For now these will be added in the organization dialog as most of the time the config will be organization specific. To be extended when needed

inherited_from \Gems_User_UserDefinitionConfigurableInterface::hasConfig()

Returns

boolean

Return true if the user has a password.

hasPassword(\Gems_User_User $user) : boolean

Seems to be only used on changing a password, so will probably never be reached

Parameters

$user

\Gems_User_User

The user to check

Returns

boolean

Return true if the user has a password.

hasPassword(\Gems_User_User $user) : boolean
Inherited
inherited_from \Gems_User_UserDefinitionInterface::hasPassword()

Parameters

$user

\Gems_User_User

The user to check

Returns

boolean

Returns true when users using this definition are staff members.

isStaff() : boolean
Inherited

Used only when the definition does not return a user_staff field.

inherited_from \Gems_User_UserDefinitionInterface::isStaff()

Returns

boolean

Handles loading the config for the given data

loadConfig(array $data) : array
inherited_from \Gems_User_UserDefinitionConfigurableInterface::loadConfig()

Parameters

$data

array

Returns

array

Handles saving the configvalues in $values using the $data

saveConfig(array $data, array $values) : array
inherited_from \Gems_User_UserDefinitionConfigurableInterface::saveConfig()

Parameters

$data

array

$values

array

Returns

array

Set the password, if allowed for this user type.

setPassword(\Gems_User_User $user, string $password) : \Gems_User_UserDefinitionInterface

Parameters

$user

\Gems_User_User

The user whose password to change

$password

string

Returns

\Gems_User_UserDefinitionInterface(continuation pattern)

Set the password, if allowed for this user type.

setPassword(\Gems_User_User $user, string $password) : \Gems_User_UserDefinitionInterface
Inherited
inherited_from \Gems_User_UserDefinitionInterface::setPassword()

Parameters

$user

\Gems_User_User

The user whose password to change

$password

string

Returns

\Gems_User_UserDefinitionInterface(continuation pattern)

Get a model to store the config

getConfigModel(boolean $valueMask = true) : \Gems_Model_JoinModel

Parameters

$valueMask

boolean

MAsk the password or if false decrypt it

Returns

\Gems_Model_JoinModel

Copied from \Gems_User_StaffUserDefinition but left out the password link

getUserSelect(\type $login_name, \type $organization) : \Zend_Db_Select
inherited_from \Gems_User_StaffUserDefinition::getUserSelect()

Parameters

$login_name

\type

$organization

\type

Returns

\Zend_Db_Select

A select used by subclasses to add fields to the select.

getUserSelect(string $login_name, integer $organization) : \Zend_Db_Select
Inherited

Parameters

$login_name

string

$organization

integer

Returns

\Zend_Db_Select

Allow overruling of password hashing.

hashPassword(string $password) : string
Inherited

Parameters

$password

string

Returns

string

 Properties

 

$_configModel

$_configModel : \Gems_Model_JoinModel

Default

 

$db

$db : \Zend_Db_Adapter_Abstract

Default

 

The time period in hours a reset key is valid for this definition.

$hoursResetKeyIsValid : integer

Default

0
 

$loader

$loader : \Gems_Loader

Default

 

$project

$project : \Gems_Project_ProjectSettings

Default

 

$project

$project : \Gems_Project_ProjectSettings

Default

 

$translate

$translate : \Zend_Translate_Adapter

Default