PHP Класс Horde_Auth_Passwd, horde

Автор: Rasmus Lerdorf ([email protected])
Автор: Chuck Hagenbuch ([email protected])
Наследование: extends Horde_Auth_Base
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$_capabilities array An array of capabilities, so that the driver can report which operations it supports and which it doesn't.
$_exclude array List of users that should be excluded from being listed/handled in any way by this driver.
$_fplock resource Filehandle for lockfile.
$_groups array Array of groups and members.
$_locked boolean Locking state.
$_users array Hash list of users.

Открытые методы

Метод Описание
__construct ( array $params = [] ) Constructor.
__destruct ( ) Writes changes to passwd file and unlocks it. Takes no arguments and has no return value. Called on script shutdown.
addUser ( string $userId, array $credentials ) Add a set of authentication credentials.
hasCapability ( string $capability ) : boolean Queries the current Auth object to find out if it supports the given capability.
listUsers ( boolean $sort = false ) : array Lists all users in the system.
removeUser ( string $userId ) Delete a set of authentication credentials.
resetPassword ( string $userId ) : string Reset a user's password. Used for example when the user does not remember the existing password.
updateUser ( string $oldID, string $newID, array $credentials ) Update a set of authentication credentials.

Защищенные методы

Метод Описание
_authenticate ( string $userId, array $credentials ) Find out if a set of login credentials are valid.
_comparePasswords ( string $encrypted, string $plaintext ) : boolean Compare an encrypted password to a plaintext string to see if they match.
_read ( ) Read and, if requested, lock the password file.

Описание методов

__construct() публичный Метод

Constructor.
public __construct ( array $params = [] )
$params array Connection parameters: 
'encryption' - (string) The encryption to use to store the password in
               the table (e.g. plain, crypt, md5-hex, md5-base64, smd5,
               sha, ssha, aprmd5).
               DEFAULT: 'crypt-des'
'filename' - (string) [REQUIRED] The passwd file to use.
'lock' - (boolean) Should we lock the passwd file? The password file
         cannot be changed (add, edit, or delete users) unless this is
         true.
         DEFAULT: false
'show_encryption' - (boolean) Whether or not to prepend the encryption
                    in the password field.
                    DEFAULT: false

__destruct() публичный Метод

Writes changes to passwd file and unlocks it. Takes no arguments and has no return value. Called on script shutdown.
public __destruct ( )

_authenticate() защищенный Метод

Find out if a set of login credentials are valid.
protected _authenticate ( string $userId, array $credentials )
$userId string The userId to check.
$credentials array An array of login credentials.

_comparePasswords() защищенный Метод

Compare an encrypted password to a plaintext string to see if they match.
protected _comparePasswords ( string $encrypted, string $plaintext ) : boolean
$encrypted string The crypted password to compare against.
$plaintext string The plaintext password to verify.
Результат boolean True if matched, false otherwise.

_read() защищенный Метод

Read and, if requested, lock the password file.
protected _read ( )

addUser() публичный Метод

Add a set of authentication credentials.
public addUser ( string $userId, array $credentials )
$userId string The userId to add.
$credentials array The credentials to add.

hasCapability() публичный Метод

Queries the current Auth object to find out if it supports the given capability.
public hasCapability ( string $capability ) : boolean
$capability string The capability to test for.
Результат boolean Whether or not the capability is supported.

listUsers() публичный Метод

Lists all users in the system.
public listUsers ( boolean $sort = false ) : array
$sort boolean Sort the users?
Результат array The array of userIds.

removeUser() публичный Метод

Delete a set of authentication credentials.
public removeUser ( string $userId )
$userId string The userId to delete.

resetPassword() публичный Метод

Reset a user's password. Used for example when the user does not remember the existing password.
public resetPassword ( string $userId ) : string
$userId string The user id for which to reset the password.
Результат string The new password.

updateUser() публичный Метод

Update a set of authentication credentials.
public updateUser ( string $oldID, string $newID, array $credentials )
$oldID string The old userId.
$newID string The new userId.
$credentials array The new credentials

Описание свойств

$_capabilities защищенное свойство

An array of capabilities, so that the driver can report which operations it supports and which it doesn't.
protected array $_capabilities
Результат array

$_exclude защищенное свойство

List of users that should be excluded from being listed/handled in any way by this driver.
protected array $_exclude
Результат array

$_fplock защищенное свойство

Filehandle for lockfile.
protected resource $_fplock
Результат resource

$_groups защищенное свойство

Array of groups and members.
protected array $_groups
Результат array

$_locked защищенное свойство

Locking state.
protected bool $_locked
Результат boolean

$_users защищенное свойство

Hash list of users.
protected array $_users
Результат array