Elgg  Version 4.x
Public Member Functions | List of all members
Loggable Interface Reference

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). More...

Public Member Functions

 getSystemLogID ()
 Return an identification for the object for storage in the system log. More...
 
 getType ()
 Return the type of the object - eg. More...
 
 getSubtype ()
 Return a subtype. More...
 
 getObjectFromID ($id)
 For a given ID, return the object associated with it. More...
 

Detailed Description

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.

To have events involving your object to be logged simply implement this interface.

Definition at line 12 of file Loggable.php.

Member Function Documentation

Loggable::getObjectFromID (   $id)

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.

Parameters
int$idGUID of an entity
Returns
static|false
Loggable::getSubtype ( )

Return a subtype.

For metadata & annotations this is the 'name' and for relationship this is the relationship type.

Returns
string
Loggable::getSystemLogID ( )

Return an identification for the object for storage in the system log.

This id must be an integer.

Returns
int
Loggable::getType ( )

Return the type of the object - eg.

object, group, user, relationship, metadata, annotation etc

Returns
string

The documentation for this interface was generated from the following file: