diff options
author | brettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544> | 2010-09-23 19:20:59 +0000 |
---|---|---|
committer | brettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544> | 2010-09-23 19:20:59 +0000 |
commit | b2fcb1602f275bbe404311dae0cf2c0a4334c893 (patch) | |
tree | 5b772397c2939e6dfde18714adcd2263acd456d0 /engine/classes/ElggObject.php | |
parent | 965cbe52f22809f19ca150feb585b0218aa89f85 (diff) | |
download | elgg-b2fcb1602f275bbe404311dae0cf2c0a4334c893.tar.gz elgg-b2fcb1602f275bbe404311dae0cf2c0a4334c893.tar.bz2 |
Refs #2450: Documented ElggSite, clarified some docs on ElggObject.
git-svn-id: http://code.elgg.org/elgg/trunk@6958 36083f99-b078-4883-b0ff-0f9b5a30f544
Diffstat (limited to 'engine/classes/ElggObject.php')
-rw-r--r-- | engine/classes/ElggObject.php | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/engine/classes/ElggObject.php b/engine/classes/ElggObject.php index 50ebe2d2d..d19e1c844 100644 --- a/engine/classes/ElggObject.php +++ b/engine/classes/ElggObject.php @@ -33,9 +33,11 @@ class ElggObject extends ElggEntity { * Load or create a new ElggObject. * * If no arguments are passed, create a new entity. - * If an argument is passed as an int, attempt to load that object by guid. - * If an argument is passed as an object, assume that it is as database result object and attempt to load - * by $obj->guid. + * + * If an argument is passed attempt to load a full Object entity. Arguments + * can be: + * - The GUID of an object entity. + * - A DB result object with a guid property * * @param mixed $guid If an int, load that GUID. If a db row then will attempt to load the rest of the data. * @throws IOException If passed an incorrect guid |