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

 Methods

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 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

Returns an initialized \Zend_Auth_Adapter_Interface

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

Parameters

$user

\Gems_User_User

$password

Returns

\Zend_Auth_Adapter_Interface

Return a password reset key

getPasswordResetKey(\Gems_User_User $user) : string

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

Returns

integer

Returns the data for a user object. It may be empty if the user is unknown.

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

Parameters

$login_name

string

$organization

integer

Returns

arrayOf data to fill the user with.

Return true if the user has a password.

hasPassword(\Gems_User_User $user) : boolean

Parameters

$user

\Gems_User_User

The user to check

Returns

boolean

Returns true when users using this definition are staff members.

isStaff() : boolean

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

Returns

boolean

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)