diff options
Diffstat (limited to 'engine/classes/Locatable.php')
| -rw-r--r-- | engine/classes/Locatable.php | 19 |
1 files changed, 16 insertions, 3 deletions
diff --git a/engine/classes/Locatable.php b/engine/classes/Locatable.php index de191ff43..980256cbb 100644 --- a/engine/classes/Locatable.php +++ b/engine/classes/Locatable.php @@ -3,34 +3,47 @@ /** * Define an interface for geo-tagging entities. * + * @package Elgg.Core + * @subpackage SocialModel.Locatable */ interface Locatable { - /** Set a location text */ + /** + * Set a location text + * + * @param string $location Textual representation of location + * + * @return bool + **/ public function setLocation($location); /** * Set latitude and longitude tags for a given entity. * - * @param float $lat - * @param float $long + * @param float $lat Latitude + * @param float $long Longitude + * + * @return bool */ public function setLatLong($lat, $long); /** * Get the contents of the ->geo:lat field. * + * @return int */ public function getLatitude(); /** * Get the contents of the ->geo:lat field. * + * @return int */ public function getLongitude(); /** * Get the ->location metadata. * + * @return string */ public function getLocation(); }
\ No newline at end of file |