diff options
author | Cash Costello <cash.costello@gmail.com> | 2012-01-01 18:30:17 -0500 |
---|---|---|
committer | Cash Costello <cash.costello@gmail.com> | 2012-01-01 18:30:17 -0500 |
commit | ce691dd8c560abc48aaf578928d13dea6ef31565 (patch) | |
tree | fb96923297830f3d92fb3f798c8e7fc37674f061 /engine/classes | |
parent | cfaa3452ae1e6035e5b9ecb668d29330b34499c2 (diff) | |
download | elgg-ce691dd8c560abc48aaf578928d13dea6ef31565.tar.gz elgg-ce691dd8c560abc48aaf578928d13dea6ef31565.tar.bz2 |
Fixes #3209 finished adding class properties documentation
Diffstat (limited to 'engine/classes')
-rw-r--r-- | engine/classes/ElggExtender.php | 11 | ||||
-rw-r--r-- | engine/classes/ElggObject.php | 1 | ||||
-rw-r--r-- | engine/classes/ElggRelationship.php | 6 | ||||
-rw-r--r-- | engine/classes/ElggRiverItem.php | 11 |
4 files changed, 27 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 { |