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 | |
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
-rw-r--r-- | engine/classes/ElggGroup.php | 3 | ||||
-rw-r--r-- | engine/classes/ElggObject.php | 3 | ||||
-rw-r--r-- | engine/classes/ElggSite.php | 4 | ||||
-rw-r--r-- | engine/classes/ElggUser.php | 9 |
4 files changed, 19 insertions, 0 deletions
diff --git a/engine/classes/ElggGroup.php b/engine/classes/ElggGroup.php index 0190e5eac..ab223e1a4 100644 --- a/engine/classes/ElggGroup.php +++ b/engine/classes/ElggGroup.php @@ -5,6 +5,9 @@ * * @package Elgg.Core * @subpackage Groups + * + * @property string $name A short name that captures the purpose of the group + * @property string $description A longer body of content that gives more details about the group */ class ElggGroup extends ElggEntity implements Friendable { diff --git a/engine/classes/ElggObject.php b/engine/classes/ElggObject.php index 0b8340697..582308f28 100644 --- a/engine/classes/ElggObject.php +++ b/engine/classes/ElggObject.php @@ -14,6 +14,9 @@ * * @package Elgg.Core * @subpackage DataModel.Object + * + * @property string $title The title, name, or summary of this object + * @property string $description The body, description, or content of the object */ class ElggObject extends ElggEntity { diff --git a/engine/classes/ElggSite.php b/engine/classes/ElggSite.php index 3ccb146fb..686046512 100644 --- a/engine/classes/ElggSite.php +++ b/engine/classes/ElggSite.php @@ -21,6 +21,10 @@ * @package Elgg.Core * @subpackage DataMode.Site * @link http://docs.elgg.org/DataModel/Sites + * + * @property string $name The name or title of the website + * @property string $description A motto, mission statement, or description of the website + * @property string $url The root web address for the site, including trailing slash */ class ElggSite extends ElggEntity { 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 { |