From 7684d074729c787c03dca4b394f9b0b6a3f108e9 Mon Sep 17 00:00:00 2001
From: Evan Winslow <evan@elgg.org>
Date: Sat, 31 Dec 2011 12:31:43 -0800
Subject: Refs #3209: Adds property docs for the four main entity classes

---
 engine/classes/ElggGroup.php  | 3 +++
 engine/classes/ElggObject.php | 3 +++
 engine/classes/ElggSite.php   | 4 ++++
 engine/classes/ElggUser.php   | 9 +++++++++
 4 files changed, 19 insertions(+)

(limited to 'engine')

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 {
-- 
cgit v1.2.3