diff options
author | Steve Clay <steve@mrclay.org> | 2013-02-04 20:37:25 -0500 |
---|---|---|
committer | Cash Costello <cash.costello@gmail.com> | 2013-02-09 07:47:28 -0500 |
commit | 85e4c16f39a8b00b229644bcd175663541dfd51a (patch) | |
tree | 49a503ec7eebe24f19025fe5ac0c890857cf86cf /engine/classes/ElggData.php | |
parent | 2cd87bb4ecf6df7b3aea9189cf1933ac3a78038c (diff) | |
download | elgg-85e4c16f39a8b00b229644bcd175663541dfd51a.tar.gz elgg-85e4c16f39a8b00b229644bcd175663541dfd51a.tar.bz2 |
Doc fixes and inline type hints for variables (big static analysis cleanup)
Diffstat (limited to 'engine/classes/ElggData.php')
-rw-r--r-- | engine/classes/ElggData.php | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/engine/classes/ElggData.php b/engine/classes/ElggData.php index 3470ee1cf..a0df3c924 100644 --- a/engine/classes/ElggData.php +++ b/engine/classes/ElggData.php @@ -5,6 +5,9 @@ * * @package Elgg.Core * @subpackage DataModel + * + * @property int $owner_guid + * @property int $time_created */ abstract class ElggData implements Loggable, // Can events related to this object class be logged @@ -33,14 +36,12 @@ abstract class ElggData implements * Passing false returns false. Core constructors always pass false. * Does nothing either way since attributes are initialized by the time * this is called. - * @return false|void False is + * @return void * @deprecated 1.8 Use initializeAttributes() */ protected function initialise_attributes($pre18_api = true) { if ($pre18_api) { elgg_deprecated_notice('initialise_attributes() is deprecated by initializeAttributes()', 1.8); - } else { - return false; } } @@ -111,7 +112,7 @@ abstract class ElggData implements * @param string $name The attribute to set * @param mixed $value The value to set it to * - * @return The success of your set funtion? + * @return bool The success of your set function? */ abstract protected function set($name, $value); @@ -195,7 +196,7 @@ abstract class ElggData implements * * @see Iterator::current() * - * @return void + * @return mixed */ public function current() { return current($this->attributes); @@ -206,7 +207,7 @@ abstract class ElggData implements * * @see Iterator::key() * - * @return void + * @return string */ public function key() { return key($this->attributes); @@ -228,7 +229,7 @@ abstract class ElggData implements * * @see Iterator::valid() * - * @return void + * @return bool */ public function valid() { return $this->valid; @@ -266,7 +267,7 @@ abstract class ElggData implements * * @param mixed $key Name * - * @return void + * @return mixed */ public function offsetGet($key) { if (array_key_exists($key, $this->attributes)) { |