diff options
author | Evan Winslow <evan@elgg.org> | 2011-12-31 12:43:02 -0800 |
---|---|---|
committer | Evan Winslow <evan@elgg.org> | 2011-12-31 12:43:02 -0800 |
commit | db073ebcb0d52f263eac5a39560b113a4aec7a1d (patch) | |
tree | 529f3f6b304bb68bc2bf00952a14872c394eac9e /engine/classes/ElggUser.php | |
parent | 8bb4bbe9fb32e0b0b0c8cf687d19f58a0e39f89a (diff) | |
parent | 7684d074729c787c03dca4b394f9b0b6a3f108e9 (diff) | |
download | elgg-db073ebcb0d52f263eac5a39560b113a4aec7a1d.tar.gz elgg-db073ebcb0d52f263eac5a39560b113a4aec7a1d.tar.bz2 |
Merge pull request #130 from ewinslow/3209-main-types
Adds docs for properties of 4 main entity types
Diffstat (limited to 'engine/classes/ElggUser.php')
-rw-r--r-- | engine/classes/ElggUser.php | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/engine/classes/ElggUser.php b/engine/classes/ElggUser.php index a1c7147a5..ab0610ac0 100644 --- a/engine/classes/ElggUser.php +++ b/engine/classes/ElggUser.php @@ -6,6 +6,15 @@ * * @package Elgg.Core * @subpackage DataModel.User + * + * @property string $name The display name that the user will be known by in the network + * @property string $username The short, reference name for the user in the network + * @property string $email The email address to which Elgg will send email notifications + * @property string $language The language preference of the user (ISO 639-1 formatted) + * @property string $banned 'yes' if the user is banned from the network, 'no' otherwise + * @property string $admin 'yes' if the user is an administrator of the network, 'no' otherwise + * @property string $password The hashed password of the user + * @property string $salt The salt used to secure the password before hashing */ class ElggUser extends ElggEntity implements Friendable { |