Base class for all user definitions.

Mainly to implement TargetAbstract.

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.

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.

inherited_from \Gems_User_UserDefinitionInterface::canSetPassword()

Parameters

$user

\Gems_User_User

Optional, the user whose password might change

Returns

boolean

Return a password reset key

getPasswordResetKey(\Gems_User_User $user) : string
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_from \Gems_User_UserDefinitionInterface::getResetKeyDurationInHours()

Returns

integer

Return true if the user has a password.

hasPassword(\Gems_User_User $user) : boolean
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

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

inherited_from \Gems_User_UserDefinitionInterface::isStaff()

Returns

boolean

Set the password, if allowed for this user type.

setPassword(\Gems_User_User $user, string $password) : \Gems_User_UserDefinitionInterface
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)

 Properties

 

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

$hoursResetKeyIsValid : integer

Default

0