GemsTracker library API
Back to top  

A standard, database stored and authenticate staff user as of version 1.5.

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
inherited_from \Gems_User_DbUserDefinitionAbstract

 Methods

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

Parameters

$user

\Gems_User_User

$password

string

Returns

\Zend_Auth_Adapter_Interface

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.

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

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

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

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)

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

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

Parameters

$login_name

string

$organization

integer

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

 

$db

$db : \Zend_Db_Adapter_Abstract

Default

 

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

$hoursResetKeyIsValid : integer

Default

0
 

$project

$project : \Gems_Project_ProjectSettings

Default