1 files changed, 49 insertions, 0 deletions
diff --git a/engine/classes/Locatable.php b/engine/classes/Locatable.php
new file mode 100644
index 000000000..7287d9798
--- /dev/null
+++ b/engine/classes/Locatable.php
@@ -0,0 +1,49 @@
+<?php
+
+/**
+ * Define an interface for geo-tagging entities.
+ *
+ * @package    Elgg.Core
+ * @subpackage SocialModel.Locatable
+ */
+interface Locatable {
+	/**
+	 * 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  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();
+}