From 7684d074729c787c03dca4b394f9b0b6a3f108e9 Mon Sep 17 00:00:00 2001 From: Evan Winslow Date: Sat, 31 Dec 2011 12:31:43 -0800 Subject: Refs #3209: Adds property docs for the four main entity classes --- engine/classes/ElggUser.php | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'engine/classes/ElggUser.php') 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 { -- cgit v1.2.3