From ce691dd8c560abc48aaf578928d13dea6ef31565 Mon Sep 17 00:00:00 2001
From: Cash Costello <cash.costello@gmail.com>
Date: Sun, 1 Jan 2012 18:30:17 -0500
Subject: Fixes #3209 finished adding class properties documentation

---
 engine/classes/ElggExtender.php     | 11 +++++++++--
 engine/classes/ElggObject.php       |  1 +
 engine/classes/ElggRelationship.php |  6 ++++++
 engine/classes/ElggRiverItem.php    | 11 +++++++++++
 mod/blog/classes/ElggBlog.php       |  4 ++++
 mod/thewire/classes/ElggWire.php    |  4 ++++
 6 files changed, 35 insertions(+), 2 deletions(-)

diff --git a/engine/classes/ElggExtender.php b/engine/classes/ElggExtender.php
index d6f79d18d..bc2d67ae2 100644
--- a/engine/classes/ElggExtender.php
+++ b/engine/classes/ElggExtender.php
@@ -3,8 +3,7 @@
  * The base class for ElggEntity extenders.
  *
  * Extenders allow you to attach extended information to an
- * ElggEntity.  Core supports two: ElggAnnotation, ElggMetadata,
- * and ElggRelationship
+ * ElggEntity.  Core supports two: ElggAnnotation and ElggMetadata.
  *
  * Saving the extender data to database is handled by the child class.
  *
@@ -16,6 +15,14 @@
  * @link       http://docs.elgg.org/DataModel/Extenders
  * @see        ElggAnnotation
  * @see        ElggMetadata
+ * 
+ * @property string $type         annotation or metadata (read-only after save)
+ * @property int    $id           The unique identifier (read-only)
+ * @property int    $entity_guid  The GUID of the entity that this extender describes
+ * @property int    $access_id    Specifies the visibility level of this extender
+ * @property string $name         The name of this extender
+ * @property mixed  $value        The value of the extender (int or string)
+ * @property int    $time_created A UNIX timestamp of when the extender was created (read-only, set on first save)
  */
 abstract class ElggExtender extends ElggData
 {
diff --git a/engine/classes/ElggObject.php b/engine/classes/ElggObject.php
index 582308f28..649e32490 100644
--- a/engine/classes/ElggObject.php
+++ b/engine/classes/ElggObject.php
@@ -17,6 +17,7 @@
  * 
  * @property string $title       The title, name, or summary of this object
  * @property string $description The body, description, or content of the object
+ * @property array  $tags        Array of tags that describe the object
  */
 class ElggObject extends ElggEntity {
 
diff --git a/engine/classes/ElggRelationship.php b/engine/classes/ElggRelationship.php
index 2d9a32cbd..efc0f7eff 100644
--- a/engine/classes/ElggRelationship.php
+++ b/engine/classes/ElggRelationship.php
@@ -4,6 +4,12 @@
  *
  * @package    Elgg.Core
  * @subpackage Core
+ * 
+ * @property int    $id           The unique identifier (read-only)
+ * @property int    $guid_one     The GUID of the subject of the relationship
+ * @property string $relationship The name of the relationship
+ * @property int    $guid_two     The GUID of the object of the relationship
+ * @property int    $time_created A UNIX timestamp of when the relationship was created (read-only, set on first save)
  */
 class ElggRelationship extends ElggData implements
 	Importable
diff --git a/engine/classes/ElggRiverItem.php b/engine/classes/ElggRiverItem.php
index fcc8f9c85..8fef6bb9d 100644
--- a/engine/classes/ElggRiverItem.php
+++ b/engine/classes/ElggRiverItem.php
@@ -4,6 +4,17 @@
  *
  * @package    Elgg.Core
  * @subpackage Core
+ * 
+ * @property int $id             The unique identifier (read-only)
+ * @property int $subject_guid   The GUID of the actor
+ * @property int $object_guid    The GUID of the object
+ * @property int $annotation_id  The ID of the annotation involved in the action 
+ * @property string $type        The type of one of the entities involved in the action
+ * @property string $subtype     The subtype of one of the entities involved in the action
+ * @property string $action_type The name of the action 
+ * @property string $view        The view for displaying this river item
+ * @property int    $access_id   The visibility of the river item
+ * @property int    $posted      UNIX timestamp when the action occurred
  */
 class ElggRiverItem
 {
diff --git a/mod/blog/classes/ElggBlog.php b/mod/blog/classes/ElggBlog.php
index ee2ec73ef..8d4401c57 100644
--- a/mod/blog/classes/ElggBlog.php
+++ b/mod/blog/classes/ElggBlog.php
@@ -1,6 +1,10 @@
 <?php
 /**
  * Extended class to override the time_created
+ * 
+ * @property string $status      The published status of the blog post (published, draft)
+ * @property string $comments_on Whether commenting is allowed (Off, On)
+ * @property string $excerpt     An excerpt of the blog post used when displaying the post
  */
 class ElggBlog extends ElggObject {
 
diff --git a/mod/thewire/classes/ElggWire.php b/mod/thewire/classes/ElggWire.php
index 3242dd5cb..5155a7f97 100644
--- a/mod/thewire/classes/ElggWire.php
+++ b/mod/thewire/classes/ElggWire.php
@@ -1,6 +1,10 @@
 <?php
 /**
  * ElggWire Class
+ * 
+ * @property string $method      The method used to create the wire post
+ * @property bool   $reply       Whether this wire post was a reply to another post
+ * @property int    $wire_thread The identifier of the thread for this wire post
  */
 class ElggWire extends ElggObject {
 
-- 
cgit v1.2.3