aboutsummaryrefslogtreecommitdiff
path: root/engine/classes/Loggable.php
diff options
context:
space:
mode:
Diffstat (limited to 'engine/classes/Loggable.php')
-rw-r--r--engine/classes/Loggable.php22
1 files changed, 19 insertions, 3 deletions
diff --git a/engine/classes/Loggable.php b/engine/classes/Loggable.php
index 6f9559849..98d131f38 100644
--- a/engine/classes/Loggable.php
+++ b/engine/classes/Loggable.php
@@ -3,11 +3,14 @@
* Interface that provides an interface which must be implemented by all objects wishing to be
* recorded in the system log (and by extension the river).
*
- * This interface defines a set of methods that permit the system log functions to hook in and retrieve
- * the necessary information and to identify what events can actually be logged.
+ * This interface defines a set of methods that permit the system log functions to
+ * hook in and retrieve the necessary information and to identify what events can
+ * actually be logged.
*
* To have events involving your object to be logged simply implement this interface.
*
+ * @package Elgg.Core
+ * @subpackage DataModel.Loggable
*/
interface Loggable {
/**
@@ -21,16 +24,23 @@ interface Loggable {
/**
* Return the class name of the object.
* Added as a function because get_class causes errors for some reason.
+ *
+ * @return string
*/
public function getClassName();
/**
* Return the type of the object - eg. object, group, user, relationship, metadata, annotation etc
+ *
+ * @return string
*/
public function getType();
/**
- * Return a subtype. For metadata & annotations this is the 'name' and for relationship this is the relationship type.
+ * Return a subtype. For metadata & annotations this is the 'name' and for relationship this is the
+ * relationship type.
+ *
+ * @return string
*/
public function getSubtype();
@@ -38,11 +48,17 @@ interface Loggable {
* For a given ID, return the object associated with it.
* This is used by the river functionality primarily.
* This is useful for checking access permissions etc on objects.
+ *
+ * @param int $id GUID of an entity
+ *
+ * @return ElggEntity
*/
public function getObjectFromID($id);
/**
* Return the GUID of the owner of this object.
+ *
+ * @return int
*/
public function getObjectOwnerGUID();
} \ No newline at end of file