Documentation

Horde_Block_Account_Base
in package

Horde_Block_Account_Base defines an API for getting/displaying account information for a user for the accounts module.

Copyright 2001-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL-2). If you did not receive this file, see http://www.horde.org/licenses/lgpl.

Tags
author

Eric Jon Rostetter eric.rostetter@physics.utexas.edu

author

Jan Schneider jan@horde.org

Table of Contents

$_params  : array<string|int, mixed>
Hash containing connection parameters.
__construct()  : mixed
Constructor.
checkPasswordStatus()  : string
Returns the status of the current password.
getFullname()  : string
Returns the user's full name.
getHome()  : string
Returns the user's home (login) directory.
getPasswordChange()  : string
Returns the date of the user's last password change.
getQuota()  : array<string|int, mixed>
Returns the user's quota if available.
getShell()  : string
Returns the user's default shell.
getUsername()  : string
Returns the username.

Properties

$_params

Hash containing connection parameters.

protected array<string|int, mixed> $_params = array()

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $params = array() ]) : mixed
Parameters
$params : array<string|int, mixed> = array()

Hash containing connection parameters.

Return values
mixed

checkPasswordStatus()

Returns the status of the current password.

public checkPasswordStatus() : string
Return values
string

A string with a warning message if the password is about to expire.

getFullname()

Returns the user's full name.

public getFullname() : string
Return values
string

The user's full name.

getHome()

Returns the user's home (login) directory.

public getHome() : string
Return values
string

The user's directory.

getPasswordChange()

Returns the date of the user's last password change.

public getPasswordChange() : string
Return values
string

Date string.

getQuota()

Returns the user's quota if available.

public getQuota() : array<string|int, mixed>
Return values
array<string|int, mixed>

A quota array, elements are used bytes and limit bytes.

getShell()

Returns the user's default shell.

public getShell() : string
Return values
string

The user's shell.

getUsername()

Returns the username.

public getUsername() : string
Return values
string

The lowercased username.

Search results