API Documentation
\

\Horde_Block_Account_Base

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.

Summary

Methods
Properties
Constants
__construct()
getUsername()
getQuota()
getFullname()
getHome()
getShell()
getPasswordChange()
checkPasswordStatus()
No public properties found
No constants found
No protected methods found
$_params
N/A
No private methods found
No private properties found
N/A

Properties

$_params

$_params : array

Hash containing connection parameters.

Type

array

Methods

__construct()

__construct(array  $params = array())

Constructor.

Parameters

array $params

Hash containing connection parameters.

getUsername()

getUsername() : string

Returns the username.

Returns

string —

The lowercased username.

getQuota()

getQuota() : array

Returns the user's quota if available.

Returns

array —

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

getFullname()

getFullname() : string

Returns the user's full name.

Returns

string —

The user's full name.

getHome()

getHome() : string

Returns the user's home (login) directory.

Returns

string —

The user's directory.

getShell()

getShell() : string

Returns the user's default shell.

Returns

string —

The user's shell.

getPasswordChange()

getPasswordChange() : string

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

Returns

string —

Date string.

checkPasswordStatus()

checkPasswordStatus() : string

Returns the status of the current password.

Returns

string —

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